Struct rocket::response::Stream[][src]

pub struct Stream<T: AsyncRead>(_, _);

Streams a response to a client from an arbitrary AsyncReader type.

The client is sent a “chunked” response, where the chunk size is at most 4KiB. This means that at most 4KiB are stored in memory while the response is being sent. This type should be used when sending responses that are arbitrarily large in size, such as when streaming from a local socket.

Implementations

impl<T: AsyncRead> Stream<T>[src]

pub fn chunked(reader: T, chunk_size: usize) -> Stream<T>[src]

Create a new stream from the given reader and sets the chunk size for each streamed chunk to chunk_size bytes.

Example

Stream a response from whatever is in stdin with a chunk size of 10 bytes. Note: you probably shouldn’t do this.

use rocket::response::Stream;

let response = Stream::chunked(tokio::io::stdin(), 10);

Trait Implementations

impl<T: AsyncRead + Debug> Debug for Stream<T>[src]

impl<T: AsyncRead> From<T> for Stream<T>[src]

Create a new stream from the given reader.

Example

Stream a response from whatever is in stdin. Note: you probably shouldn’t do this.

use rocket::response::Stream;

let response = Stream::from(tokio::io::stdin());

impl<'r, 'o: 'r, T: AsyncRead + Send + 'o> Responder<'r, 'o> for Stream<T>[src]

Sends a response to the client using the “Chunked” transfer encoding. The maximum chunk size is 4KiB.

Failure

If reading from the input stream fails at any point during the response, the response is abandoned, and the response ends abruptly. An error is printed to the console with an indication of what went wrong.

Auto Trait Implementations

impl<T> RefUnwindSafe for Stream<T> where
    T: RefUnwindSafe

impl<T> Send for Stream<T> where
    T: Send

impl<T> Sync for Stream<T> where
    T: Sync

impl<T> Unpin for Stream<T> where
    T: Unpin

impl<T> UnwindSafe for Stream<T> where
    T: UnwindSafe

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<!> for T[src]

impl<T> From<T> for T[src]

impl<T> Instrument for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> IntoCollection<T> for T

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

impl<V, T> VZip<V> for T where
    V: MultiLane<T>,