Enum lnpbp::strict_encoding::Error

pub enum Error {
    Io(ErrorKind),
    Utf8Conversion,
    ExceedMaxItems(usize),
    WrongOptionalEncoding(u8),
    EnumValueOverflow(String),
    EnumValueNotKnown(String, u8),
    UnsupportedDataStructure(&'static str),
    ValueOutOfRange(&'static str, Range<u128>, u128),
    RepeatedValue(String),
    DataNotEntirelyConsumed,
    DataIntegrityError(String),
}

Possible errors during strict encoding and decoding process

Variants

Io(ErrorKind)

I/O Error

Utf8Conversion

UTF8 Conversion Error

ExceedMaxItems(usize)

A collection (slice, vector or other type) has more items than 2^16 (i.e. maximum value which may be held by u16 size representation according to the LNPBP-6 spec)

WrongOptionalEncoding(u8)

In terms of strict encoding, we interpret Option as a zero-length Vec (for Optional::None) or single-item Vec (for Optional::Some). For decoding an attempt to read Option from a encoded non-0 or non-1 length Vec will result in Error::WrongOptionalEncoding.

EnumValueOverflow(String)

Enums are encoded as a u8-based values; the provided enum has underlying primitive type that does not fit into u8 value

EnumValueNotKnown(String, u8)

An unsupported value for enum encountered during decode operation

UnsupportedDataStructure(&'static str)

The data are correct, however their structure indicate that they were created with the future software version which has functional absent in the current implementation

ValueOutOfRange(&'static str, Range<u128>, u128)

Found a value during decoding operation that does not fits into the supported range

RepeatedValue(String)

A repeated value found during set collection deserialization

DataNotEntirelyConsumed

Returned by the convenience method strict_decode if not all provided data were consumed during decoding process

DataIntegrityError(String)

Convenience type never for data structures using StrictDecode

Trait Implementations

impl Clone for Error

pub fn clone(&self) -> Error

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Eq for Error

impl Error for Error

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 From<Error> for String

pub fn from(err: Error) -> Self

Performs the conversion.

impl From<Error> for Error

pub fn from(_: Error) -> Self

Performs the conversion.

impl From<Error> for Error

pub fn from(err: Error) -> Self

Performs the conversion.

impl From<Error> for Error

pub fn from(_: Error) -> Self

Performs the conversion.

impl From<Error> for Error

pub fn from(e: Error) -> Self

Performs the conversion.

impl From<Error> for ParseError

pub fn from(v: Error) -> Self

Performs the conversion.

impl From<Error> for Error

pub fn from(v: Error) -> Self

Performs the conversion.

impl From<Error> for Error

pub fn from(v: Error) -> Self

Performs the conversion.

impl From<FromUtf8Error> for Error

pub fn from(v: FromUtf8Error) -> Self

Performs the conversion.

impl From<Utf8Error> for Error

pub fn from(v: Utf8Error) -> Self

Performs the conversion.

impl PartialEq<Error> for Error

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

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

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

This method tests for !=.

impl StructuralEq for Error

impl StructuralPartialEq for Error