Enum ChunkingError 

pub enum ChunkingError {
    InvalidPayloadLengthError {
        received: usize,
        expected: usize,
    },
    TooLongPayloadLengthError {
        received: usize,
        expected_at_most: usize,
    },
    MalformedHeaderError,
    TooShortFragmentHeader {
        received: usize,
        expected: usize,
    },
    MalformedFragmentIdentifier {
        received: i32,
    },
}

The idea behind the process of chunking is to incur as little data overhead as possible due to very computationally costly sphinx encapsulation procedure.

To achieve this, the underlying message is split into so-called “sets”, which are further subdivided into the base unit of “fragment” that is directly encapsulated by a Sphinx packet. This allows to encapsulate messages of arbitrary length.

Each message, regardless of its size, consists of at least a single Set that has at least a single Fragment.

Each Fragment can have variable, yet fully deterministic, length, that depends on its position in the set as well as total number of sets. This is further explained in fragment.rs file.

Similarly, each Set can have a variable number of Fragments inside. However, that value is more restrictive: if it’s the last set into which the message was split (or implicitly the only one), it has no lower bound on the number of Fragments. (Apart from the restriction of containing at least a single one). If the set is located somewhere in the middle, it must be full. Finally, regardless of its position, it must also be true that it contains no more than u8::MAX, i.e. 255 Fragments. Again, the reasoning for this is further explained in set.rs file. However, you might also want to look at fragment.rs to understand the full context behind that design choice.

Both of those concepts as well as their structures, i.e. Set and Fragment are further explained in the respective files.

Variants

InvalidPayloadLengthError

Fields

received: usize

expected: usize

TooLongPayloadLengthError

Fields

received: usize

expected_at_most: usize

MalformedHeaderError

TooShortFragmentHeader

Fields

received: usize

expected: usize

MalformedFragmentIdentifier

Fields

received: i32

Trait Implementations

impl Debug for ChunkingError

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

Formats the value using the given formatter.

impl Display for ChunkingError

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

Formats the value using the given formatter.

impl Error for ChunkingError

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 ChunkingError

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

impl StructuralPartialEq for ChunkingError