Enum DecodeError

#[non_exhaustive]
pub enum DecodeError {
    ChunkNotFound {
        backtrace: Option<Backtrace>,
        span_trace: SpanTrace,
    },
    ParentNotFound {
        node: TreeNode,
        backtrace: Option<Backtrace>,
        span_trace: SpanTrace,
    },
    LeafNotFound {
        num: ChunkNum,
        backtrace: Option<Backtrace>,
        span_trace: SpanTrace,
    },
    ParentHashMismatch {
        node: TreeNode,
        backtrace: Option<Backtrace>,
        span_trace: SpanTrace,
    },
    LeafHashMismatch {
        num: ChunkNum,
        backtrace: Option<Backtrace>,
        span_trace: SpanTrace,
    },
    Read {
        source: ReadError,
        backtrace: Option<Backtrace>,
        span_trace: SpanTrace,
    },
    DecodeIo {
        source: Error,
        backtrace: Option<Backtrace>,
        span_trace: SpanTrace,
    },
}

Decode error that you can get once you have sent the request and are decoding the response, e.g. from AtBlobContent::next.

This is similar to bao_tree::io::DecodeError, but takes into account that we are reading from a RecvStream, so read errors will be propagated as DecodeError::Read, containing a ReadError. This carries more concrete information about the error than an io::Error.

When the provider finds that it does not have a chunk that we requested, or that the chunk is invalid, it will stop sending data without producing an error. This is indicated by either the DecodeError::ParentNotFound or DecodeError::LeafNotFound variant, which can be used to detect that data is missing but the connection as well that the provider is otherwise healthy.

The DecodeError::ParentHashMismatch and DecodeError::LeafHashMismatch variants indicate that the provider has sent us invalid data. A well-behaved provider should never do this, so this is an indication that the provider is not behaving correctly.

The DecodeError::DecodeIo variant is just a fallback for any other io error that is not actually a DecodeError::Read.

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.

ChunkNotFound

A chunk was not found or invalid, so the provider stopped sending data

Fields

backtrace: Option<Backtrace>

span_trace: SpanTrace

ParentNotFound

A parent was not found or invalid, so the provider stopped sending data

Fields

node: TreeNode

backtrace: Option<Backtrace>

span_trace: SpanTrace

LeafNotFound

A parent was not found or invalid, so the provider stopped sending data

Fields

num: ChunkNum

backtrace: Option<Backtrace>

span_trace: SpanTrace

ParentHashMismatch

The hash of a parent did not match the expected hash

Fields

node: TreeNode

backtrace: Option<Backtrace>

span_trace: SpanTrace

LeafHashMismatch

The hash of a leaf did not match the expected hash

Fields

num: ChunkNum

backtrace: Option<Backtrace>

span_trace: SpanTrace

Read

Error when reading from the stream

Fields

source: ReadError

backtrace: Option<Backtrace>

span_trace: SpanTrace

DecodeIo

A generic io error

Fields

source: Error

backtrace: Option<Backtrace>

span_trace: SpanTrace

Trait Implementations

impl Debug for DecodeError

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

Formats the value using the given formatter.

impl Display for DecodeError

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

Formats the value using the given formatter.

impl Error for DecodeError

where Self: Debug + Display,

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 source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

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 ErrorCompat for DecodeError

fn backtrace(&self) -> Option<&Backtrace>

Returns a Backtrace that may be printed.

fn iter_chain(&self) -> ChainCompat<'_, '_>

where Self: AsErrorSource,

Returns an iterator for traversing the chain of errors, starting with the current error and continuing with recursive calls to Error::source.

impl From<AtBlobHeaderNextError> for DecodeError

fn from(cause: AtBlobHeaderNextError) -> Self

Converts to this type from the input type.

impl From<DecodeError> for DecodeError

fn from(value: DecodeError) -> Self

Converts to this type from the input type.

impl From<DecodeError> for Error

fn from(cause: DecodeError) -> Self

Converts to this type from the input type.

impl From<DecodeError> for GetError

fn from(value: DecodeError) -> Self

Converts to this type from the input type.

impl From<Error> for DecodeError

fn from(value: Error) -> Self

Converts to this type from the input type.