https://github.com/rydz/rocket_seek_stream

Rocket-rs responder to range requests using types that implement Read + Seek
https://github.com/rydz/rocket_seek_stream

partial-content range-requests rocket rocket-rs rust

Last synced: 4 months ago
JSON representation

Rocket-rs responder to range requests using types that implement Read + Seek

• Host: GitHub
• URL: https://github.com/rydz/rocket_seek_stream
• Owner: rydz
• License: mit
• Created: 2019-09-06T15:14:18.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-05-04T08:08:51.000Z (almost 2 years ago)
• Last Synced: 2024-03-14T08:43:39.938Z (11 months ago)
• Topics: partial-content, range-requests, rocket, rocket-rs, rust
• Language: Rust
• Homepage:
• Size: 54.7 KB
• Stars: 21
• Watchers: 3
• Forks: 8
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# rocket_seek_stream

[crates.io](https://crates.io/crates/rocket_seek_stream)

A [Rocket](https://github.com/SergioBenitez/Rocket) responder for types implementing the `AsyncRead + AsyncSeek` traits, such as files and `rocket::futures::io::Cursor`, that will respond to range requests with a 206 Partial Content response. The `Content-Type` can optionally be inferred by taking a sample of bytes from the beginning of the stream, or given manually. An `Accept-Ranges: bytes` header will be sent in all responses to notify browsers that range requests are supported for the resource.

This supports both single and multipart/byterange requests.

[https://tools.ietf.org/html/rfc7233](https://tools.ietf.org/html/rfc7233)

## Cargo.toml

Add this to your dependencies.

```

rocket_seek_stream = {git="https://github.com/rydz/rocket_seek_stream"}

```

## Examples

Serving a file from the disk

```rust

#![feature(proc_macro_hygiene, decl_macro)]

#[macro_use]

extern crate rocket;

use rocket_seek_stream::SeekStream;

#[get("/")]

fn home<'a>() -> std::io::Result> {

    SeekStream::from_path("kosmodrom.webm")

}

#[rocket::main]

async fn main() {

    match rocket::build().mount("/", routes![home]).launch().await {

        Ok(_) => (),

        Err(e) => {

            eprintln!("Rocket stopped unexpectedly. (Error {})", e);

        }

    };

}

```

Serving an in memory buffer

```rust

#[get("/")]

fn cursor<'a>() -> SeekStream<'a> {

    let bytes = &include_bytes!("./fly_me_to_the_moon.webm")[..];

    let len = bytes.len();

    let stream = std::io::Cursor::new(bytes);

    SeekStream::with_opts(stream, len as u64, "video/webm")

}

```

Use `cargo run --example server` to run the example. run `examples/download.sh` to download the media it depends on using [yt-dlp](https://github.com/yt-dlp/yt-dlp).

## TODO

- Write some tests

I've compared the output of the Golang stdlib http router's multipart response to what I output here and it looks about the same except for a small difference in whitespace.