Skip to main content

Error

Enum Error 

Source
pub enum Error {
    Truncated {
        what: &'static str,
        needed: usize,
        found: usize,
    },
    InvalidMagic {
        what: &'static str,
    },
    BadValue(&'static str),
    Unsupported(&'static str),
    TooLarge {
        what: &'static str,
        limit: usize,
    },
}
Expand description

The single error type of the pith suite.

Every fallible operation across the workspace returns Result<T>, which uses this type, so a caller that handles errors once handles all of them. Each variant carries a &'static str naming the field or structure at fault, so a message names a thing rather than saying “invalid input”.

Display never allocates and never runs the formatting machinery: it concatenates the literal prefix with the what field through Formatter::write_str alone. The numeric payloads (needed, found, limit) stay reachable through Debug, which derives normally.

Variants§

§

Truncated

Input ended before a structure that the format guarantees.

Fields

§what: &'static str

What was being read, e.g. "idat chunk".

§needed: usize

How many bytes the structure needs.

§found: usize

How many bytes were actually there.

§

InvalidMagic

A magic number, signature or fixed field did not match.

Fields

§what: &'static str

The field that did not match, e.g. "PNG signature".

§

BadValue(&'static str)

A structurally valid but semantically impossible value: a zero denominator, a declared length that cannot fit, a table index past the end of the table.

§

Unsupported(&'static str)

A real format variant this crate deliberately does not implement. This is not a failure to parse; it is a refusal to guess.

§

TooLarge

An allocation the format could request but that exceeds a configured ceiling. Always a refusal, never an OOM.

Fields

§what: &'static str

The thing whose size exceeded the ceiling.

§limit: usize

The configured ceiling, in bytes.

Implementations§

Source§

impl Error

Source

pub fn truncated(what: &'static str, needed: usize, found: usize) -> Self

Builds Error::Truncated without spelling the struct literal.

Source

pub fn too_large(what: &'static str, limit: usize) -> Self

Builds Error::TooLarge without spelling the struct literal.

Trait Implementations§

Source§

impl Clone for Error

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for Error

Source§

impl Debug for Error

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for Error

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for Error

Source§

impl PartialEq for Error

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Error

Auto Trait Implementations§

§

impl Freeze for Error

§

impl RefUnwindSafe for Error

§

impl Send for Error

§

impl Sync for Error

§

impl Unpin for Error

§

impl UnsafeUnpin for Error

§

impl UnwindSafe for Error

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.