Enum DecodeError

pub enum DecodeError {
    InvalidBencodexValueError,
    UnexpectedTokenError {
        token: u8,
        point: usize,
    },
}

The error type which is returned from decoding a Bencodex value through Decode::decode.

Variants

InvalidBencodexValueError

This should be used when it failed to decode. In future, it will be separated more and more.

UnexpectedTokenError

This should be used when it failed to decode because there is unexpected token appeared while decoding.

Example

For example, The encoded bytes of BencodexValue::Number are formed as ‘i{}e’ (e.g., ‘i0e’, ‘i2147483647e’). If it is not satisified, it should be result through inside Err.

use bencodex::{ Decode, DecodeError };

//                     v -- should be b'0' ~ b'9' digit.
let vec = vec![b'i', b':', b'e'];
let error = vec.decode().unwrap_err();
let expected_error = DecodeError::UnexpectedTokenError {
    token: b':',
    point: 1,
};
assert_eq!(expected_error, error);

Fields

token: u8

point: usize

Trait Implementations

impl Debug for DecodeError

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

Formats the value using the given formatter.

impl Display for DecodeError

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

Formats the value using the given formatter.

impl Error for DecodeError

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 PartialEq for DecodeError

fn eq(&self, other: &DecodeError) -> 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.

impl StructuralPartialEq for DecodeError