Struct SizeExceeded 

pub struct SizeExceeded { /* private fields */ }

A byte count that went over its limit.

The one shape of every “too large” error, so each reader reports the same two numbers and converts it without re-spelling the fields. Only Self::check and Self::check_limit build one, so size is always above max.

Examples

use mcpls_core::error::{Error, SizeExceeded};

fn oversize(error: &Error) -> Option<&SizeExceeded> {
    match error {
        Error::FileSizeLimitExceeded(exceeded) => Some(exceeded),
        _ => None,
    }
}

Implementations

impl SizeExceeded

pub const fn size(&self) -> u64

The size found, in bytes.

pub const fn max(&self) -> NonZeroU64

The limit that was exceeded, in bytes; always below Self::size.

pub const fn check(size: u64, max: NonZeroU64) -> Result<(), Self>

Checks size against max.

Errors

Returns the exceeded limit when size is over max.

pub const fn check_limit(size: u64, limit: SizeLimit) -> Result<(), Self>

Checks size against limit, which admits everything when unlimited.

Errors

Returns the exceeded limit when size is over limit.

Trait Implementations

impl Clone for SizeExceeded

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for SizeExceeded

impl Debug for SizeExceeded

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

Formats the value using the given formatter.

impl Display for SizeExceeded

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

Formats the value using the given formatter.

impl Eq for SizeExceeded

impl Error for SizeExceeded

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 PartialEq for SizeExceeded

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for SizeExceeded