Enum bpx::error::Error

pub enum Error {
    Checksum(u32, u32),
    Io(Error),
    TypeError(&'static str, &'static str),
    PropCountExceeded(usize),
    MissingProp(&'static str),
    Truncation(&'static str),
    Corruption(String),
    Utf8(&'static str),
    Unsupported(String),
    Capacity(usize),
    Deflate(&'static str),
    Inflate(&'static str),
    Other(String),
}

Represents a BPX error

Variants

Checksum(u32, u32)

Describes a checksum error

Arguments

• expected checksum value
• actual checksum value

Io(Error)

Describes an io error

Arguments

• the error that occured

TypeError(&'static str, &'static str)

Describes a type conversion error (Structured Data)

Arguments

• expected type name
• actual type name

PropCountExceeded(usize)

Describes too many props or values attempted to be written as part of an Object or Array (Structured Data) (ie exceeds 255)

Arguments

• actual count of props

MissingProp(&'static str)

Describes a missing property in an object (Structured Data)

Arguments

• name of missing prop

Truncation(&'static str)

Describes a data truncation error, this means a section or the file itself has been truncated

Arguments

• last operation name before failure

Corruption(String)

Describes a data corruption error, this means an impossible byte or sequence of bytes has been found

Arguments

• message

Utf8(&'static str)

Describes an utf8 decoding/encoding error

Arguments

• last operation name before failure

Unsupported(String)

Describes an operation or flag that is currently unsupported

Arguments

• message

Capacity(usize)

Describes a section that is too large to be written (ie exceeds 2 pow 32 / 4Gb)

Arguments

• actual size of section

Deflate(&'static str)

Describes a compression error

Arguments

• error description string

Inflate(&'static str)

Describes a decompression error

Arguments

• error description string

Other(String)

Describes a generic unknown error

Arguments

• error message

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl From<&'_ str> for Error

fn from(e: &str) -> Self

Performs the conversion.

impl From<Error> for Error

fn from(e: Error) -> Self

Performs the conversion.