Enum DecodeError

pub enum DecodeError {
    UnknownVersion,
    UnknownRequiredFeature,
    InvalidValue,
    ShortRead,
    BadLengthDescriptor,
    Io(ErrorKind),
    UnsupportedCompression,
    DangerousValue,
}

An error in decoding a message or struct.

Variants

UnknownVersion

A version byte specified something we don’t know how to handle.

Includes unknown realm byte in an onion hop data packet.

UnknownRequiredFeature

Unknown feature mandating we fail to parse message (e.g., TLV with an even, unknown type)

InvalidValue

Value was invalid.

For example, a byte which was supposed to be a bool was something other than a 0 or 1, a public key/private key/signature was invalid, text wasn’t UTF-8, TLV was syntactically incorrect, etc.

ShortRead

The buffer to be read was too short.

BadLengthDescriptor

A length descriptor in the packet didn’t describe the later data correctly.

Io(ErrorKind)

Error from std::io.

UnsupportedCompression

The message included zlib-compressed values, which we don’t support.

DangerousValue

Value is validly encoded but is dangerous to use.

This is used for things like ChannelManager deserialization where we want to ensure that we don’t use a ChannelManager which is in out of sync with the ChannelMonitor. This indicates that there is a critical implementation flaw in the storage implementation and it’s unsafe to continue.

Trait Implementations

impl Clone for DecodeError

fn clone(&self) -> DecodeError

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DecodeError

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

Formats the value using the given formatter.

impl Display for DecodeError

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

Formats the value using the given formatter.

impl From<DecodeError> for Bolt12ParseError

fn from(error: DecodeError) -> Bolt12ParseError

Converts to this type from the input type.

impl From<Error> for DecodeError

fn from(e: Error) -> DecodeError

Converts to this type from the input type.

impl Hash for DecodeError

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

where __H: Hasher,

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

impl StructuralPartialEq for DecodeError