Struct hkd32::Path

#[repr(transparent)]
pub struct Path(_);

Key derivation paths: location within a key hierarchy which names/identifies a specific key.

This is the reference type. The corresponding owned type is hkd32::Path (ala the corresponding types in std).

Methods

impl Path

pub fn new<P: ?Sized>(path: &P) -> Result<&Self, Error> where
    P: AsRef<[u8]>, 

Create a path from a byte slice.

Returns Error if the path is malformed.

pub fn as_bytes(&self) -> &[u8]

Obtain a reference to this path's bytestring serialization.

Important traits for Components<'a>

impl<'a> Iterator for Components<'a> type Item = Component<'a>;

pub fn components(&self) -> Components

Obtain a component iterator for this path.

pub fn is_root(&self) -> bool

Is this path the root path?

pub fn join<P>(&self, path: P) -> PathBuf where
    P: AsRef<Path>, 

Create a PathBuf with path joined to self.

Requires the alloc feature is enabled.

pub fn parent(&self) -> Option<&Path>

Get the parent path for this path

pub fn stringify(&self) -> Result<String, Error>

Attempt to convert this path to an /x/y/z string.

This will only succeed if the path components are all ASCII.

Requires the alloc feature is enabled.

pub fn to_vec(&self) -> Vec<u8>

Serialize this Path as a byte vector

Trait Implementations

impl Debug for Path

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

Formats the value using the given formatter.

impl PartialEq<Path> for Path

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Eq for Path

impl Ord for Path

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialOrd<Path> for Path

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Hash for Path

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, 

Feeds a slice of this type into the given [Hasher].

impl AsRef<Path> for Path

fn as_ref(&self) -> &Self

Performs the conversion.

impl AsRef<Path> for PathBuf

fn as_ref(&self) -> &Path

Performs the conversion.

impl Borrow<Path> for PathBuf

fn borrow(&self) -> &Path

Immutably borrows from an owned value.

impl ToOwned for Path

type Owned = PathBuf

The resulting type after obtaining ownership.

fn to_owned(&self) -> PathBuf

Creates owned data from borrowed data, usually by cloning.

fn clone_into(&self, target: &mut Self::Owned)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

Uses borrowed data to replace owned data, usually by cloning.