Struct Error 

pub struct Error { /* private fields */ }

A codec error: its ErrorKind and the input offset where it was found.

Examples

use compress_lib::{Error, ErrorKind};

fn check(e: Error) -> bool {
    matches!(e.kind(), ErrorKind::OutputLimit | ErrorKind::RatioLimit)
}

Implementations

impl Error

pub const fn kind(&self) -> ErrorKind

What went wrong.

Examples

use compress_lib::{ErrorKind, Level};

assert_eq!(Level::new(10).unwrap_err().kind(), ErrorKind::InvalidLevel);

pub const fn offset(&self) -> u64

The offset in the compressed input (bytes since the engine started or was last reset) where the problem was found; 0 for configuration errors.

Examples

use compress_lib::Level;

assert_eq!(Level::new(10).unwrap_err().offset(), 0);

pub const fn code(&self) -> &'static str

The stable identifier of the kind, as ErrorKind::code.

Examples

use compress_lib::Level;

assert_eq!(Level::new(10).unwrap_err().code(), "compress.invalid_level");

Trait Implementations

impl Clone for Error

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 Error

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 Eq for Error

impl Error for Error

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 From<Error> for ErrorKind

fn from(e: Error) -> Self

Converts to this type from the input type.

impl From<Error> for Error

Available on crate feature std only.

fn from(e: Error) -> Self

Converts to this type from the input type.

impl Hash for Error

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Error

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Error