Enum PlanError 

pub enum PlanError {
    BufferTooSmall {
        needed: usize,
        actual: usize,
    },
    AlignmentTooLarge {
        alignment_log2: u8,
    },
    PayloadOverflow,
    TooManySections {
        count: usize,
    },
    DuplicateKind {
        kind: u32,
    },
}

Error returned by snapshot writers.

Returned by SnapshotPlan::new, SnapshotPlan::write_into, and the alloc-gated SnapshotBuilder methods.

Performance

perf: unspecified; errors are returned only from writer paths.

Variants

BufferTooSmall

The output buffer is smaller than the snapshot’s encoded length.

Fields

needed: usize

Bytes required by the encoded snapshot.

actual: usize

Bytes provided in the output buffer.

AlignmentTooLarge

A section’s alignment_log2 exceeds MAX_ALIGNMENT_LOG2.

Fields

alignment_log2: u8

Declared alignment_log2 value.

PayloadOverflow

Computed offsets or lengths overflowed u64 or usize.

TooManySections

More sections were supplied than the v1 cap permits.

Fields

count: usize

Section count actually supplied.

DuplicateKind

Two pending sections shared the same kind.

Fields

kind: u32

Duplicated section kind.

Trait Implementations

impl Clone for PlanError

fn clone(&self) -> PlanError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for PlanError

impl Debug for PlanError

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

Formats the value using the given formatter.

impl Display for PlanError

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

Formats the value using the given formatter.

impl Eq for PlanError

impl Error for PlanError

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 PlanError

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