Struct ByteStream

pub struct ByteStream<S>(pub S);

A potentially infinite stream of bytes: any T: AsRef<[u8]>.

A ByteStream can be constructed from any Stream of items of type T where T: AsRef<[u8]>. This includes Vec<u8>, &[u8], &str, &RawStr, and more. The stream can be constructed directly, via ByteStream(..) or ByteStream::from(), or through generator syntax via ByteStream!.

Responder

ByteStream is a (potentially infinite) responder. The response Content-Type is set to Binary. The body is unsized, and values are sent as soon as they are yielded by the internal iterator.

Example

Use ByteStream! to yield 10 3-byte vectors, one every second, of the form vec![i, i + 1, i + 2] for i from 0 to 10 exclusive:

use rocket::response::stream::ByteStream;
use rocket::futures::stream::{repeat, StreamExt};
use rocket::tokio::time::{self, Duration};

#[get("/bytes")]
fn bytes() -> ByteStream![&'static [u8]] {
    ByteStream(repeat(&[1, 2, 3][..]))
}

#[get("/byte/stream")]
fn stream() -> ByteStream![Vec<u8>] {
    ByteStream! {
        let mut interval = time::interval(Duration::from_secs(1));
        for i in 0..10u8 {
            yield vec![i, i + 1, i + 2];
            interval.tick().await;
        }
    }
}

The syntax of ByteStream! as an expression is identical to that of stream!.

Tuple Fields

0: S

Trait Implementations

impl<S: Clone> Clone for ByteStream<S>

fn clone(&self) -> ByteStream<S>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<S: Debug> Debug for ByteStream<S>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<S> From<S> for ByteStream<S>

fn from(stream: S) -> Self

Creates a ByteStream from any S: Stream.

impl<'r, S> Responder<'r, 'r> for ByteStream<S>

where S: Send + 'r + Stream, S::Item: AsRef<[u8]> + Send + Unpin + 'r,

fn respond_to(self, _: &'r Request<'_>) -> Result<'r>

Returns Ok if a Response could be generated successfully. Otherwise, returns an Err with a failing Status.