Struct TransferLimit 

pub struct TransferLimit<C = usize, P = NoopProgress<C>> { /* private fields */ }

Builder for applying byte-count transfer limits to fallible streams.

Implementations

impl TransferLimit<usize, NoopProgress<usize>>

pub fn new(limit: usize) -> Self

Create a transfer limit that allows at most limit bytes.

pub fn optional(limit: Option<usize>) -> Self

Create a transfer limit from an optional byte limit.

pub fn unlimited() -> Self

Create a transfer tracker without a byte limit.

impl<C> TransferLimit<C, NoopProgress<C>>

where C: TransferCounter,

pub fn from_limit(limit: C) -> Self

Create a transfer limit using an explicit counter type.

pub fn from_optional_limit(limit: Option<C>) -> Self

Create a transfer limit from an optional byte limit using an explicit counter type.

impl<C, P> TransferLimit<C, P>

where C: TransferCounter,

pub fn with_limit(self, limit: C) -> Self

Set the maximum allowed number of bytes.

A stream is allowed to produce exactly limit bytes. It fails on the first chunk that makes the cumulative total greater than limit.

pub fn without_limit(self) -> Self

Remove the maximum byte limit while keeping progress tracking.

pub fn on_progress<F>(self, on_progress: F) -> TransferLimit<C, F>

where F: FnMut(C),

Replace the progress callback.

The callback receives cumulative bytes after every successful chunk read from the inner stream, including the chunk that crosses the limit.

pub fn limit(&self) -> Option<C>

Return the configured maximum byte count, if any.

pub fn wrap<S>( self, stream: S, ) -> impl Stream<Item = Result<S::Ok, TransferLimitError<S::Error, C>>>

where S: TryStream, S::Ok: ChunkLength, P: FnMut(C) + Unpin,

Wrap a fallible stream and apply this transfer limit.

Trait Implementations

impl<C: Clone, P: Clone> Clone for TransferLimit<C, P>

fn clone(&self) -> TransferLimit<C, P>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<C: Debug, P: Debug> Debug for TransferLimit<C, P>

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

Formats the value using the given formatter.

impl<C> Default for TransferLimit<C, NoopProgress<C>>

where C: TransferCounter,

fn default() -> Self

Returns the “default value” for a type.