Enum Error

#[non_exhaustive]
pub enum Error {
    Truncated,
    Incomplete {
        deficit: Sensitive<NonZeroUsize>,
    },
    ExtraneousBytes,
    BadLengthValue,
    BadMessage(&'static str),
    InvalidMessage(Cow<'static, str>),
    MissingData,
    Bug(Bug),
}

Error type for decoding Tor objects from bytes.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Truncated

👎Deprecated since 0.22.0: Use Reader::incomplete_error instead.

Something was truncated

It might be an inner data structure, or the outer message being parsed.

Incomplete

Tried to read something, but we didn’t find enough bytes.

This can means that the outer object is truncated. Possibly we need to read more and try again,

This error is only returned by Readers created with from_possibly_incomplete_slice.

Do not directly construct this variant

It is usually a bug to explicitly construct this variant. Use Reader::incomplete_error instead.

In tests using Reader::from_slice_for_test, use Error::new_incomplete_for_test.

Fields

deficit: Sensitive<NonZeroUsize>

Lower bound on number of additional bytes needed

ExtraneousBytes

Called Reader::should_be_exhausted(), but found bytes anyway.

BadLengthValue

Invalid length value

BadMessage(&'static str)

👎Deprecated since 0.6.2: Use InvalidMessage instead.

An attempt to parse an object failed for some reason related to its contents.

InvalidMessage(Cow<'static, str>)

An attempt to parse an object failed for some reason related to its contents.

General case, more specific variants also exist

This variant is used when encountering parsing trouble for which there is no more specific variant.

Other variants can occur when deserialising malformed messages. for example (but not necessarily only): ExtraneousBytes, MissingData, and BadLengthValue.

MissingData

The message contains data which is too short (perhaps in an inner counted section)

Usually, do not directly construct this variant

It is often a bug to explicitly construct this variant. Consider Reader::incomplete_error instead.

(It can be appropriate in test cases, or during bespoke parsing of an inner substructure.)

Bug(Bug)

A parsing error that should never happen.

We use this one in lieu of calling assert() and expect() and unwrap() from within parsing code.

Implementations

impl Error

pub fn new_incomplete_for_test(deficit: usize) -> Self

Make an Error::Incomplete with a specified deficit

Suitable for use in tests.

Panics

Panics if the specified deficit is zero.

Trait Implementations

impl Clone for Error

fn clone(&self) -> Error

Returns a copy of the value.

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

Performs copy-assignment from source.

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, __formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

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

fn from(source: Bug) -> Self

Converts to this type from the input type.

impl PartialEq for Error

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.