Struct MinimumThroughputDownloadBody

pub struct MinimumThroughputDownloadBody<B> { /* private fields */ }

A body-wrapping type that ensures data is being streamed faster than some lower limit.

If data is being streamed too slowly, this body type will emit an error next time it’s polled.

Implementations

impl<B> MinimumThroughputDownloadBody<B>

pub fn new( time_source: impl TimeSource + 'static, async_sleep: impl AsyncSleep + 'static, body: B, options: MinimumThroughputBodyOptions, ) -> Self

Create a new minimum throughput body.

Trait Implementations

impl<B> Body for MinimumThroughputDownloadBody<B>

where B: Body<Data = Bytes, Error = BoxError>,

type Data = Bytes

Values yielded by the Body.

type Error = Box<dyn Error + Sync + Send>

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>, 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 map_data<F, B>(self, f: F) -> MapData<Self, F>

where Self: Sized, F: FnMut(Self::Data) -> B, B: Buf,

Maps this body’s data value to a different value.

fn map_err<F, E>(self, f: F) -> MapErr<Self, F>

where Self: Sized, F: FnMut(Self::Error) -> E,

Maps this body’s error value to a different value.

fn collect(self) -> Collect<Self>

where Self: Sized,

Turn this body into Collected body which will collect all the DATA frames and trailers.

impl<'__pin, B> Unpin for MinimumThroughputDownloadBody<B>

where PinnedFieldsOf<__Origin<'__pin, B>>: Unpin,