Struct Error 

pub struct Error { /* private fields */ }

Error type for any encoding/decoding operations.

A simple string representation is forced onto all implementations for simplicity. This is because most of the time, a encoding/decoding error indicates a bug that requires human attention to fix anyway; even when handling untrusted data, the program is likely to only be interested in knowing that an error did occur, instead of handling based on cause.

There might be cases where allocations must be avoided. A feature could be added in the future that turns the repr into () to address this. Such a feature would be a non-breaking change so there’s no need to add it now.

Implementations

impl Error

pub fn input_exhausted() -> Error

Creates an Error which indicates that the input stream has ended prematurely.

pub fn length_mismatch(expected: usize, actual: usize) -> Error

Creates an Error which indicates that the length (likely prefix) is different from the expected value.

pub fn value_out_of_range<V>(value: V, type_name: &str) -> Error

where V: Display,

Creates an Error which indicates that the input value is out of range.

pub fn unknown_enum_tag<V>(tag: V, type_name: &str) -> Error

where V: Display,

Creates an Error which indicates that the enum tag does not belong to a known variant.

pub fn custom<T>(content: T) -> Error

where T: Display,

Creates an Error using a custom error string.

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

Available on crate feature std only.

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.