[][src]Struct body_image_futio::AsyncBodyImage

#[must_use = "streams do nothing unless polled"]pub struct AsyncBodyImage<B, BA = LenientArbiter> where
    B: OutputBuf,
    BA: BlockingArbiter + Default + Unpin
{ /* fields omitted */ }

Adaptor for BodyImage, implementing the futures::Stream and http_body::Body traits.

The http_body::Body trait makes this usable with hyper as the B body type of http::Request<B> (client) or http::Response<B> (server).

The stream Item type is an OutputBuf, implemented here for Bytes or UniBodyBuf. The later provides zero-copy MemMap support (*mmap feature only).

Tunables::buffer_size_fs is used for reading the body when in FsRead state.

See also YieldBodyImage, SplitBodyImage, DispatchBodyImage and PermitBodyImage which provide additional coordination of blocking operations.

Implementations

impl<B, BA> AsyncBodyImage<B, BA> where
    B: OutputBuf,
    BA: BlockingArbiter + Default + Unpin
[src]

pub fn new(body: BodyImage, tune: FutioTunables) -> Self[src]

Wrap by consuming the BodyImage instance.

Note: BodyImage and FutioTunables are Clone (inexpensive), so that can be done beforehand to preserve owned copies.

Trait Implementations

impl<B, BA> Body for AsyncBodyImage<B, BA> where
    B: OutputBuf,
    BA: BlockingArbiter + Default + Unpin
[src]

type Data = B

Values yielded by the Body.

type Error = Error

The error type this Body might generate.

impl<B: Debug, BA: Debug> Debug for AsyncBodyImage<B, BA> where
    B: OutputBuf,
    BA: BlockingArbiter + Default + Unpin
[src]

impl<B, BA> Stream for AsyncBodyImage<B, BA> where
    B: OutputBuf,
    BA: BlockingArbiter + Default + Unpin
[src]

type Item = Result<B, Error>

Values yielded by the stream.

impl<B, BA> StreamWrapper for AsyncBodyImage<B, BA> where
    B: OutputBuf,
    BA: BlockingArbiter + Default + Unpin
[src]

Auto Trait Implementations

impl<B, BA = LenientArbiter> !RefUnwindSafe for AsyncBodyImage<B, BA>[src]

impl<B, BA> Send for AsyncBodyImage<B, BA> where
    BA: Send
[src]

impl<B, BA> Sync for AsyncBodyImage<B, BA> where
    BA: Sync
[src]

impl<B, BA> Unpin for AsyncBodyImage<B, BA>[src]

impl<B, BA = LenientArbiter> !UnwindSafe for AsyncBodyImage<B, BA>[src]

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<T> for T[src]

impl<T> Instrument for T[src]

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

impl<T> StreamExt for T where
    T: Stream + ?Sized
[src]

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<S, T, E> TryStream for S where
    S: Stream<Item = Result<T, E>> + ?Sized
[src]

type Ok = T

The type of successful values yielded by this future

type Error = E

The type of failures yielded by this future

impl<S> TryStreamExt for S where
    S: TryStream + ?Sized
[src]

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