Enum bencodex::codec::decode::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 of UnexpectedTokenError

token: u8point: usize

Trait Implementations

impl Debug for DecodeError

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

Formats the value using the given formatter.

impl Display for DecodeError

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

Formats the value using the given formatter.

impl Error for DecodeError

pub fn source(&self) -> Option<&(dyn Error + 'static)>

The lower-level source of this error, if any.

pub fn backtrace(&self) -> Option<&Backtrace>

🔬 This is a nightly-only experimental API. (backtrace)

Returns a stack backtrace, if available, of where this error occurred.

pub fn description(&self) -> &str

👎 Deprecated since 1.42.0:

use the Display impl or to_string()

pub fn cause(&self) -> Option<&dyn Error>

👎 Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

impl PartialEq<DecodeError> for DecodeError

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for DecodeError