Struct stream_body::StreamBody

pub struct StreamBody { /* fields omitted */ }

An HttpBody implementation which handles data streaming in an efficient way.

It is similar to Body.

Methods

impl StreamBody

pub fn empty() -> StreamBody

Creates an empty body.

pub fn channel() -> (PipeWriter, StreamBody)

Creates a body stream with an associated writer half.

Useful when wanting to stream chunks from another thread.

pub fn channel_with_capacity(capacity: usize) -> (PipeWriter, StreamBody)

Creates a body stream with an associated writer half having a specific size of internal buffer.

Useful when wanting to stream chunks from another thread.

pub fn from_reader<R: AsyncRead + Unpin + Send + 'static>(r: R) -> StreamBody

A helper method to convert an AsyncRead to a StreamBody. If there is any error thrown during the reading/writing, it will be logged via log::error!.

Trait Implementations

impl Body for StreamBody

type Data = StreamData

Values yielded by the Body.

type Error = Error

The error type this Body might generate.

fn poll_data(
    self: Pin<&mut Self>,
    cx: &mut Context
) -> Poll<Option<Result<Self::Data, Self::Error>>>

Attempt to pull out the next data buffer of this stream.

fn poll_trailers(
    self: Pin<&mut Self>,
    _cx: &mut Context
) -> Poll<Result<Option<HeaderMap<HeaderValue>>, Self::Error>>

Poll for an optional single HeaderMap of trailers.

fn is_end_stream(&self) -> bool

Returns true when the end of stream has been reached.

fn size_hint(&self) -> SizeHint

Returns the bounds on the remaining length of the stream.

fn data(&mut self) -> Data<Self> where
    Self: Unpin, 

Returns future that resolves to next data chunk, if any.

fn trailers(&mut self) -> Trailers<Self> where
    Self: Unpin, 

Returns future that resolves to trailers, if any.

impl From<&'static [u8]> for StreamBody

fn from(slice: &'static [u8]) -> StreamBody

Performs the conversion.

impl From<&'static str> for StreamBody

fn from(slice: &'static str) -> StreamBody

Performs the conversion.

impl From<Bytes> for StreamBody

fn from(chunk: Bytes) -> StreamBody

Performs the conversion.

impl From<Cow<'static, [u8]>> for StreamBody

fn from(cow: Cow<'static, [u8]>) -> StreamBody

Performs the conversion.

impl From<Cow<'static, str>> for StreamBody

fn from(cow: Cow<'static, str>) -> StreamBody

Performs the conversion.

impl From<String> for StreamBody

fn from(s: String) -> StreamBody

Performs the conversion.

impl From<Vec<u8>> for StreamBody

fn from(vec: Vec<u8>) -> StreamBody

Performs the conversion.