Enum EncodeError 

#[non_exhaustive]
pub enum EncodeError {
    Capacity {
        needed: usize,
        available: usize,
    },
}

An encode that failed.

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.

Capacity

The output buffer is shorter than the encoding.

Fields

needed: usize

The bytes the encoding needs: a lower bound, not always the whole requirement.

An encoder that knows its size before it writes reports the whole encoding. One that builds incrementally — the FlatBuffers encoder does, because a child’s size is known only once it is written — reports what it needed at the point it gave up, which is at least available + 1 and at most the whole encoding. Either way a caller that grows the buffer to needed has made progress, and one that wants a buffer that always suffices uses Payload::MAX_SIZE.

available: usize

The bytes the output buffer has.

Trait Implementations

impl Clone for EncodeError

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for EncodeError

impl Debug for EncodeError

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

Formats the value using the given formatter.

impl Eq for EncodeError

impl PartialEq for EncodeError

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for EncodeError