Enum Error 

pub enum Error<F: Family> {
    NonLeaf(Position<F>),
    PositionOverflow(Position<F>),
    LocationOverflow(Location<F>),
    Empty,
    RangeOutOfBounds(Location<F>),
    InvalidSize(u64),
    LeafOutOfBounds(Location<F>),
    DuplicateLocation(Location<F>),
    UnsortedLocation(Location<F>),
    ElementPruned(Position<F>),
    CompressedDigest(Position<F>),
    InvalidPinnedNodes,
    StaleBatch {
        expected: Position<F>,
        actual: Position<F>,
    },
    AncestorDropped {
        expected: Position<F>,
        actual: Position<F>,
    },
    InvalidProof,
    InvalidInactivePeaks {
        requested: usize,
        peaks: usize,
    },
    RootMismatch,
    Metadata(Error),
    Journal(Error),
    MissingNode(Position<F>),
    DataCorrupted(&'static str),
    BitOutOfBounds(u64, u64),
}

Errors that can occur when interacting with a Merkle-family data structure.

Variants

NonLeaf(Position<F>)

The position does not correspond to a leaf node.

PositionOverflow(Position<F>)

The position exceeds the valid range.

LocationOverflow(Location<F>)

The location exceeds the valid range.

Empty

The range is empty but must contain at least one element.

RangeOutOfBounds(Location<F>)

The end of a range is out of bounds.

InvalidSize(u64)

The requested size is invalid.

LeafOutOfBounds(Location<F>)

A requested leaf location exceeds the current leaf count.

DuplicateLocation(Location<F>)

A requested leaf location repeats the location before it.

UnsortedLocation(Location<F>)

A requested leaf location is less than the location before it.

ElementPruned(Position<F>)

A required node was not available (e.g. pruned).

CompressedDigest(Position<F>)

A required digest was compressed into a synthetic accumulator (e.g. a backward-fold suffix accumulator) when the source proof was constructed, so it is not individually available. Unlike Error::ElementPruned, the digest still exists in the source structure; the caller can recover by supplying it through an explicit witness slice.

InvalidPinnedNodes

The provided pinned node list does not match the expected pruning boundary.

StaleBatch

The structure is at none of the states recorded by the batch’s chain, so applying the batch would combine it with a different history.

Fields

expected: Position<F>

The base size when the batch chain was forked.

actual: Position<F>

The current structure size.

AncestorDropped

An unapplied ancestor batch was dropped before this batch was merkleized, so this batch lacks that ancestor’s changes. Keep an ancestor alive until it is applied or until the descendants that will be applied have been merkleized.

Fields

expected: Position<F>

The size the structure would have after applying the batch and its ancestors.

actual: Position<F>

The structure’s size when the batch was rejected.

InvalidProof

The proof is invalid.

InvalidInactivePeaks

The requested inactive peak count cannot be represented by the current peak list.

Fields

requested: usize

Requested inactive peak count.

peaks: usize

Number of available peaks.

RootMismatch

The root does not match the computed root.

Metadata(Error)

A metadata error occurred.

Journal(Error)

A journal error occurred.

MissingNode(Position<F>)

A required node is missing.

DataCorrupted(&'static str)

Data is corrupted.

BitOutOfBounds(u64, u64)

Bit offset is out of bounds.

Trait Implementations

impl<F: Debug + Family> Debug for Error<F>

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

Formats the value using the given formatter.

impl<F: Family> Display for Error<F>

where Position<F>: Display, Location<F>: Display,

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

Formats the value using the given formatter.

impl<F: Family> Error for Error<F>

where Self: Debug + Display,

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<F: Family> From<Error<F>> for Error<F>

fn from(source: Error<F>) -> Self

Converts to this type from the input type.

impl<F: Family> From<Error<F>> for Error<F>

fn from(source: Error<F>) -> Self

Converts to this type from the input type.

impl<F: Family> From<Error> for Error<F>

fn from(source: Error) -> Self

Converts to this type from the input type.

impl<F: Family> From<Error> for Error<F>

fn from(source: Error) -> Self

Converts to this type from the input type.