Enum MultikeyError 

#[non_exhaustive]
pub enum MultikeyError {
    InvalidMultibase,
    DecodedTooShort(usize),
    UnknownCodecPrefix,
    UnknownCodecName {
        reason: CodecNameReason,
    },
    KeyLengthMismatch {
        codec: MultikeyCodecKind,
        expected: usize,
        actual: usize,
    },
    KeyTooLarge {
        codec: MultikeyCodecKind,
        max: usize,
        actual: usize,
    },
    EncodedPayloadTooLarge,
    BindingTypeCodecMismatch {
        binding_type: BindingTypeKind,
        codec: MultikeyCodecKind,
        algorithm: BindingAlgorithmKind,
    },
    BindingAlgorithmMismatch {
        binding_alg: BindingAlgorithmKind,
        codec_algorithm: BindingAlgorithmKind,
    },
    BindingAlgorithmMissing {
        binding_type: BindingTypeKind,
    },
}

Error returned when parsing, encoding, or validating a multikey fails.

Parsing fails closed: malformed input yields one of these variants.

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.

InvalidMultibase

The input is not a valid multibase string.

DecodedTooShort(usize)

The decoded bytes are too short to hold a codec prefix and key.

UnknownCodecPrefix

The multicodec prefix is not a recognized key type.

UnknownCodecName

The given codec name is not one of the supported names.

Fields

reason: CodecNameReason

Which class of unknown codec name was supplied.

KeyLengthMismatch

The key length does not match the length required by the codec.

Fields

codec: MultikeyCodecKind

Canonical codec name whose length requirement was violated.

expected: usize

Key length in bytes the codec requires.

actual: usize

Key length in bytes that was supplied.

KeyTooLarge

A variable-length key exceeded this crate’s semantic safety limit.

Fields

codec: MultikeyCodecKind

Canonical codec name whose length limit was violated.

max: usize

Maximum accepted key length in bytes.

actual: usize

Key length in bytes that was supplied.

EncodedPayloadTooLarge

The final multikey payload exceeded the base58btc safety limit.

BindingTypeCodecMismatch

The binding type is incompatible with the key’s multicodec.

Fields

binding_type: BindingTypeKind

Declared binding type.

codec: MultikeyCodecKind

Canonical codec name implied by the key.

algorithm: BindingAlgorithmKind

Algorithm string implied by the codec.

BindingAlgorithmMismatch

The declared binding algorithm disagrees with the codec’s algorithm.

Fields

binding_alg: BindingAlgorithmKind

Algorithm declared in the binding.

codec_algorithm: BindingAlgorithmKind

Algorithm string implied by the codec.

BindingAlgorithmMissing

A required explicit algorithm was omitted for this binding type.

Fields

binding_type: BindingTypeKind

Binding type that requires an explicit algorithm.

Trait Implementations

impl Debug for MultikeyError

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

Formats the value using the given formatter.

impl Display for MultikeyError

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

Formats the value using the given formatter.

impl Error for MultikeyError

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.