Enum ProtocolError 

pub enum ProtocolError {
    Identity(ContentError),
    NonCanonicalId {
        presented: String,
    },
    InvalidId {
        kind: &'static str,
        reason: String,
    },
    UnsupportedFeature {
        feature: String,
        known: bool,
    },
    NonCanonical {
        schema: String,
        input_len: usize,
    },
    Malformed {
        reason: String,
    },
    UnknownSchema {
        tag: String,
        expected: &'static str,
    },
}

What can go wrong constructing or reading a protocol record.

Variants

Identity(ContentError)

A canonical encoding or content-id operation failed.

NonCanonicalId

An id was presented in a form that is not its canonical rendering. Accepting an alternate spelling would let two strings name one record.

Fields

presented: String

What the caller supplied.

InvalidId

An identifier’s shape is invalid (empty, or outside the charset).

Fields

kind: &'static str

Which identifier kind was rejected.

reason: String

Why it was rejected.

UnsupportedFeature

A REQUIRED surface feature could not be met — either this build does not recognize it, or the surface lacks it. Both are the same fact to an operator: the document cannot be shown faithfully.

Fields

feature: String

The feature name, verbatim as the document wrote it.

known: bool

Whether this build recognizes the name at all.

NonCanonical

The bytes decode, but they are not the canonical encoding of what they decode to — reordered map keys, a non-minimal integer, an indefinite-length string. Accepting them would mint an id different from the one their author published.

Fields

schema: String

The tag the record declared.

input_len: usize

Length of the input.

Malformed

The bytes are not a readable record. Corruption is a different fact from a version we do not know, and is reported differently.

Fields

reason: String

What could not be read.

UnknownSchema

A record declared a schema tag this build does not know. Unknown REQUIRED behavior fails closed (ADR law 5).

Fields

tag: String

The tag the record carried.

expected: &'static str

The tag this build understands.

Trait Implementations

impl Debug for ProtocolError

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

Formats the value using the given formatter.

impl Display for ProtocolError

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

Formats the value using the given formatter.

impl Error for ProtocolError

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 From<ContentError> for ProtocolError

fn from(source: ContentError) -> Self

Converts to this type from the input type.

impl From<ProtocolError> for Refusal

fn from(source: ProtocolError) -> Self

Converts to this type from the input type.

impl From<ProtocolError> for LifecycleError

fn from(source: ProtocolError) -> Self

Converts to this type from the input type.