Enum tor_keymgr::KeyPath

#[non_exhaustive]
pub enum KeyPath {
    Arti(ArtiPath),
    CTor(CTorPath),
}

The identifier of a key.

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.

Arti(ArtiPath)

An Arti key path.

CTor(CTorPath)

A C-Tor key path.

Implementations

impl KeyPath

pub fn matches(&self, pat: &KeyPathPattern) -> Option<Vec<KeyPathRange>>

Check whether this KeyPath matches the specified KeyPathPattern.

If the KeyPath matches the pattern, this returns the ranges that match its dynamic parts.

Example

let path = KeyPath::Arti(ArtiPath::new("foo_bar_baz_1".into())?);
let pattern = KeyPathPattern::Arti("*_bar_baz_*".into());
let matches = path.matches(&pattern).unwrap();

let path = path.arti().unwrap();
assert_eq!(matches.len(), 2);
assert_eq!(path.substring(&matches[0]), Some("foo"));
assert_eq!(path.substring(&matches[1]), Some("1"));

pub fn arti(&self) -> Option<&ArtiPath>

Return the underlying ArtiPath, if this is a KeyPath::Arti.

pub fn ctor(&self) -> Option<&CTorPath>

Return the underlying CTorPath, if this is a KeyPath::CTor.

Trait Implementations

impl Clone for KeyPath

fn clone(&self) -> KeyPath

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for KeyPath

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

Formats the value using the given formatter.

impl Display for KeyPath

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

Formats the value using the given formatter.

impl From<ArtiPath> for KeyPath

fn from(original: ArtiPath) -> KeyPath

Converts to this type from the input type.

impl From<CTorPath> for KeyPath

fn from(original: CTorPath) -> KeyPath

Converts to this type from the input type.

impl Hash for KeyPath

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl KeySpecifier for KeyPath

fn arti_path(&self) -> StdResult<ArtiPath, ArtiPathUnavailableError>

The location of the key in the Arti key store.

fn ctor_path(&self) -> Option<CTorPath>

The location of the key in the C Tor key store (if supported).

impl Ord for KeyPath

fn cmp(&self, other: &KeyPath) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for KeyPath

fn eq(&self, other: &KeyPath) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for KeyPath

fn partial_cmp(&self, other: &KeyPath) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for KeyPath

impl StructuralPartialEq for KeyPath