Enum strict_encoding::Error

pub enum Error {
    Io(IoError),
    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(IoError)

I/O error during data strict encoding: {0}

Utf8Conversion

String data are not in valid UTF-8 encoding

ExceedMaxItems(usize)

A collection (slice, vector or other type) has more items ({0}) 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 {0} has underlying primitive type that does not fit into u8 value

EnumValueNotKnown(String, u8)

An unsupported value {0} for enum {0} 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. More details from error source: {0}

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

Decoding resulted in value {2} for type {0} that exceeds the supported range {1:#?}

RepeatedValue(String)

A repeated value for {0} 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)

Data integrity problem during strict decoding operation: {0}

Trait Implementations

impl Clone for Error

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

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

Formats the value using the given formatter.

impl Display for Error

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 Error

fn from(_: Error) -> Self

Performs the conversion.

impl From<Error> for Error

fn from(e: Error) -> Self

Performs the conversion.

impl From<Error> for Error

fn from(v: Error) -> Self

Performs the conversion.

impl From<ErrorKind> for Error

fn from(v: ErrorKind) -> Self

Performs the conversion.

impl From<FromUtf8Error> for Error

fn from(v: FromUtf8Error) -> Self

Performs the conversion.

impl From<Utf8Error> for Error

fn from(v: Utf8Error) -> Self

Performs the conversion.

impl Hash for Error

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

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<Error> for Error

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

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

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

This method tests for !=.

impl StructuralEq for Error

impl StructuralPartialEq for Error