Enum TransferLimitError 

pub enum TransferLimitError<E, C = usize> {
    LimitExceeded {
        limit: C,
        actual: C,
    },
    CounterOverflow {
        bytes_seen: C,
        chunk_len: usize,
    },
    Inner {
        source: E,
    },
}

Error returned by a transfer-limited stream.

Variants

LimitExceeded

The stream produced more bytes than allowed.

Fields

limit: C

Configured maximum number of bytes.

actual: C

Number of bytes observed after reading the chunk that crossed the limit.

CounterOverflow

The cumulative byte count cannot be represented by the selected counter.

Fields

bytes_seen: C

Number of bytes counted before reading the chunk that overflowed.

chunk_len: usize

Byte length of the chunk that could not be added to the counter.

Inner

The wrapped stream returned an error.

Fields

source: E

Original stream error.

Implementations

impl<E, C> TransferLimitError<E, C>

pub fn is_limit_exceeded(&self) -> bool

Returns true when this error represents an exceeded transfer limit.

pub fn is_counter_overflow(&self) -> bool

Returns true when the selected counter type could not represent the cumulative byte count.

pub fn into_inner(self) -> Option<E>

Returns the wrapped stream error, if this is an inner stream error.

Trait Implementations

impl<E: Debug, C: Debug> Debug for TransferLimitError<E, C>

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

Formats the value using the given formatter.

impl<E, C> Display for TransferLimitError<E, C>

where C: Display,

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

Formats the value using the given formatter.

impl<E, C> Error for TransferLimitError<E, C>

where E: Error + 'static, Self: Debug + Display,

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl<E, C> From<E> for TransferLimitError<E, C>

fn from(source: E) -> Self

Converts to this type from the input type.