Enum SecretEncodeError 

#[non_exhaustive]
pub enum SecretEncodeError {
    InputTooLarge {
        input_len: usize,
        maximum_input_len: usize,
    },
    OutputFull {
        required: usize,
        available: usize,
    },
    OverlappingBuffers,
    AddressRangeOverflow,
    LengthOverflow,
    AllocationFailed,
    Failed,
    Complete,
}

Error returned by a secret encoding frame.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

InputTooLarge

The public cumulative input length exceeds the declared frame limit.

Fields

input_len: usize

Public input bytes presented so far.

maximum_input_len: usize

Public maximum input bytes declared at construction.

OutputFull

Secret output storage cannot hold the declared maximum encoded result.

Fields

required: usize

Required encoded bytes for the declared input bound.

available: usize

Available secret output bytes.

OverlappingBuffers

Secret input and output storage overlap.

AddressRangeOverflow

A byte-range end address cannot be represented by usize.

LengthOverflow

Encoded-length or source-position arithmetic overflowed.

AllocationFailed

A preallocated heap encoder could not reserve its complete storage.

Failed

The encoder previously failed and is absorbing.

Complete

The encoder has already completed successfully.

Trait Implementations

impl Clone for SecretEncodeError

fn clone(&self) -> SecretEncodeError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for SecretEncodeError

impl Debug for SecretEncodeError

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

Formats the value using the given formatter.

impl Display for SecretEncodeError

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

Formats the value using the given formatter.

impl Eq for SecretEncodeError

impl Error for SecretEncodeError

Available on crate feature std only.

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 SecretEncodeError

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for SecretEncodeError