Struct hkd32::PathBuf

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

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

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

Methods

impl PathBuf

pub fn from_bytes<B>(bytes: B) -> Result<Self, Error> where
    B: AsRef<[u8]>, 

Parse a path from its bytestring serialization.

pub fn new() -> Self

Create a new PathBuf representing the root derivation path.

This is also the default value for PathBuf.

pub fn as_path(&self) -> &Path

Borrow this PathBuf as a Path

pub fn extend<'a, I, C>(&mut self, components: I) where
    I: IntoIterator<Item = C>,
    C: AsRef<Component<'a>>, 

Extend this key derivation path with additional components.

pub fn push<'a, C: AsRef<Component<'a>>>(&mut self, component: C)

Push an additional component onto this path.

Methods from Deref<Target = Path>

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 PathBuf

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

Formats the value using the given formatter.

impl PartialEq<PathBuf> for PathBuf

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

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

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

This method tests for !=.

impl Eq for PathBuf

impl Ord for PathBuf

fn cmp(&self, other: &PathBuf) -> 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<PathBuf> for PathBuf

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

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

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

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

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

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

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

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

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

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

impl FromStr for PathBuf

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Error>

Parse a derivation path from a string.

Derivation path strings look like Unix paths (e.g. "/foo/bar/baz"). They are delimited by a slash character (/ a.k.a. hkd32::DELIMITER) and must start with a leading slash.

Empty path components are not allowed (e.g. //, /foo//)

impl Deref for PathBuf

type Target = Path

The resulting type after dereferencing.

fn deref(&self) -> &Path

Dereferences the value.

impl Drop for PathBuf

fn drop(&mut self)

Executes the destructor for this type.

impl Hash for PathBuf

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 PathBuf

fn as_ref(&self) -> &Path

Performs the conversion.

impl Clone for PathBuf

fn clone(&self) -> PathBuf

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for PathBuf

fn default() -> PathBuf

Returns the "default value" for a type.

impl Borrow<Path> for PathBuf

fn borrow(&self) -> &Path

Immutably borrows from an owned value.

impl Zeroize for PathBuf

fn zeroize(&mut self)

Zero out this object from memory (using Rust or OS intrinsics which ensure the zeroization operation is not "optimized away")