Enum tor_keymgr::key_specifier::KeyPathError

#[non_exhaustive]
pub enum KeyPathError {
    PatternNotMatched(ArtiPath),
    Unrecognized(KeyPath),
    InvalidArtiPath {
        error: ArtiPathSyntaxError,
        path: ArtiPath,
    },
    InvalidKeyPathComponentValue {
        error: InvalidKeyPathComponentValue,
        key: String,
        path: ArtiPath,
        value: Slug,
    },
    Bug(Bug),
}

An error while attempting to extract information about a key given its path

For example, from a KeyPathInfoExtractor.

See also crate::keystore::arti::MalformedPathError, which occurs at a lower level.

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.

PatternNotMatched(ArtiPath)

The path did not match the expected pattern.

Unrecognized(KeyPath)

The path is not recognized.

Returned by KeyMgr::describe when none of its KeyPathInfoExtractors is able to parse the specified KeyPath.

InvalidArtiPath

Found an invalid ArtiPath, which is syntactically invalid on its face

Fields

error: ArtiPathSyntaxError

What was wrong with the value

path: ArtiPath

The offending ArtiPath.

InvalidKeyPathComponentValue

An invalid key path component value string was encountered

When attempting to interpret a key path, one of the elements in the path contained a string value which wasn’t a legitimate representation of the type of data expected there for this kind of key.

(But the key path is in the proper character set.)

Fields

error: InvalidKeyPathComponentValue

What was wrong with the value

key: String

The name of the “key” (what data we were extracting)

Should be valid Rust identifier syntax.

path: ArtiPath

The ArtiPath of the key.

value: Slug

The substring of the ArtiPath that couldn’t be parsed.

Bug(Bug)

An internal error.

Trait Implementations

impl Clone for KeyPathError

fn clone(&self) -> KeyPathError

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for KeyPathError

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

Formats the value using the given formatter.

impl Display for KeyPathError

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

Formats the value using the given formatter.

impl Error for KeyPathError

fn source(&self) -> Option<&(dyn Error + 'static)>

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<Bug> for KeyPathError

fn from(source: Bug) -> Self

Converts to this type from the input type.

impl From<KeyPathError> for KeystoreCorruptionError

fn from(source: KeyPathError) -> Self

Converts to this type from the input type.