Struct PathBuf 

pub struct PathBuf { /* private fields */ }

Path to an item in a library, i.e. module, procedure, constant or type.

Implementations

impl PathBuf

Constructors

pub fn with_capacity(capacity: usize) -> Self

Get an empty PathBuf with capacity bytes allocated for the underlying path storage

pub fn new<S>(source: &S) -> Result<Self, PathError>

where S: AsRef<str> + ?Sized,

Returns a new path created from the provided source.

A path consists of at list of components separated by :: delimiter. A path must contain at least one component.

Errors

Returns an error if:

• The path is empty.
• Any component of the path is empty.
• Any component is not a valid identifier (quoted or unquoted) in Miden Assembly syntax, i.e. starts with an ASCII alphabetic character, contains only printable ASCII characters, except for ::, which must only be used as a path separator.

pub fn absolute<S>(source: &S) -> Self

where S: AsRef<str> + ?Sized,

Create an absolute Path from a pre-validated string

pub fn relative<S>(source: &S) -> Self

where S: AsRef<str> + ?Sized,

Create a relative Path from a pre-validated string

pub fn as_path(&self) -> &Path

Get a Path corresponding to the this PathBuf

pub fn into_boxed_path(self) -> Box<Path>

Convert this mutable PathBuf into an owned, read-only alloc::boxed::Box<Path>

impl PathBuf

Mutation

pub fn set_parent<P>(&mut self, parent: &P)

where P: AsRef<Path> + ?Sized,

Overrides the parent prefix of this path.

The parent prefix is the part of the path consisting of all components but the last one.

If there is only a single component in self, this function is equivalent to appending self to parent.

pub fn push<P>(&mut self, path: &P)

where P: AsRef<Path> + ?Sized,

Extends self with path

If path is absolute, it replaces the current path.

This function ensures that the joined path correctly delimits each path component.

pub fn pop(&mut self) -> bool

Truncates self to Path::parent.

Returns false if self.parent() is None, otherwise true.

Methods from Deref<Target = Path>

pub const MAX_COMPONENT_LENGTH: usize = 255usize

pub const EMPTY: &Path

pub const KERNEL_PATH: &str = "$kernel"

pub const ABSOLUTE_KERNEL_PATH: &str = "::$kernel"

pub const KERNEL: &Path

pub const EXEC_PATH: &str = "$exec"

pub const ABSOLUTE_EXEC_PATH: &str = "::$exec"

pub const EXEC: &Path

pub fn as_str(&self) -> &str

pub fn as_ident(&self) -> Option<Ident>

Get an Ident that is equivalent to this Path, so long as the path has only a single component.

Returns None if the path cannot be losslessly represented as a single component.

pub fn to_path_buf(&self) -> PathBuf

Convert this Path to an owned PathBuf

pub fn is_empty(&self) -> bool

Returns true if this path is empty (i.e. has no components)

pub fn len(&self) -> usize

Returns the number of components in the path

pub fn char_len(&self) -> usize

Return the size of the path in chars when displayed as a string

pub fn byte_len(&self) -> usize

Return the size of the path in bytes when displayed as a string

pub fn is_absolute(&self) -> bool

Returns true if this path is an absolute path

pub fn to_absolute(&self) -> Cow<'_, Path>

Make this path absolute, if not already

NOTE: This does not resolve the path, it simply ensures the path has the root prefix

pub fn to_relative(&self) -> &Path

Strip the root prefix from this path, if it has one.

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

Returns the Path without its final component, if there is one.

This means it may return an empty Path for relative paths with a single component.

Returns None if the path terminates with the root prefix, or if it is empty.

pub fn components(&self) -> Iter<'_>

Returns an iterator over all components of the path.

pub fn first(&self) -> Option<&str>

Get the first non-root component of this path as a str

Returns None if the path is empty, or consists only of the root prefix.

pub fn last(&self) -> Option<&str>

Get the first non-root component of this path as a str

Returns None if the path is empty, or consists only of the root prefix.

pub fn split_first(&self) -> Option<(&str, &Path)>

Splits this path on the first non-root component, returning it and a new Path of the remaining components.

Returns None if there are no components to split

pub fn split_last(&self) -> Option<(&str, &Path)>

Splits this path on the last component, returning it and a new Path of the remaining components.

Returns None if there are no components to split

pub fn is_kernel_path(&self) -> bool

Returns true if this path is for the root kernel module.

pub fn is_in_kernel(&self) -> bool

Returns true if this path is for the root kernel module or an item in it

pub fn is_exec_path(&self) -> bool

Returns true if this path is for an executable module.

pub fn starts_with<Prefix>(&self, prefix: &Prefix) -> bool

where Prefix: ?Sized, Self: StartsWith<Prefix>,

Returns true if the current path, sans root component, starts with prefix

pub fn starts_with_exactly<Prefix>(&self, prefix: &Prefix) -> bool

where Prefix: ?Sized, Self: StartsWith<Prefix>,

Returns true if the current path, including root component, starts with prefix

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

Create an owned PathBuf with path adjoined to self.

If path is absolute, it replaces the current path.

See PathBuf::push for more details on what it means to adjoin a path.

Trait Implementations

impl<'a> AddAssign<&'a Ident> for PathBuf

fn add_assign(&mut self, rhs: &'a Ident)

Performs the += operation.

impl<'a> AddAssign<&'a Path> for PathBuf

fn add_assign(&mut self, rhs: &'a Path)

Performs the += operation.

impl<'a> AddAssign<&'a ProcedureName> for PathBuf

fn add_assign(&mut self, rhs: &'a ProcedureName)

Performs the += operation.

impl<'a> AddAssign<&'a str> for PathBuf

fn add_assign(&mut self, rhs: &'a str)

Performs the += operation.

impl AsRef<Path> for PathBuf

fn as_ref(&self) -> &Path

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<str> for PathBuf

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<Path> for PathBuf

fn borrow(&self) -> &Path

Immutably borrows from an owned value.

impl Clone for PathBuf

fn clone(&self) -> PathBuf

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PathBuf

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

Formats the value using the given formatter.

impl Default for PathBuf

fn default() -> PathBuf

Returns the “default value” for a type.

impl Deref for PathBuf

type Target = Path

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Deserializable for PathBuf

fn read_from<R: ByteReader>( source: &mut R, ) -> Result<Self, DeserializationError>

Reads a sequence of bytes from the provided source, attempts to deserialize these bytes into Self, and returns the result.

fn read_from_bytes(bytes: &[u8]) -> Result<Self, DeserializationError>

Attempts to deserialize the provided bytes into Self and returns the result.

impl Display for PathBuf

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

Formats the value using the given formatter.

impl<'a> From<&'a Path> for PathBuf

fn from(path: &'a Path) -> Self

Converts to this type from the input type.

impl From<Cow<'_, Path>> for PathBuf

fn from(value: Cow<'_, Path>) -> Self

Converts to this type from the input type.

impl From<Ident> for PathBuf

fn from(component: Ident) -> Self

Converts to this type from the input type.

impl From<PathBuf> for Arc<Path>

fn from(value: PathBuf) -> Self

Converts to this type from the input type.

impl From<PathBuf> for QualifiedProcedureName

fn from(path: PathBuf) -> Self

Converts to this type from the input type.

impl From<PathBuf> for String

fn from(path: PathBuf) -> Self

Converts to this type from the input type.

impl FromStr for PathBuf

type Err = PathError

The associated error which can be returned from parsing.

fn from_str(value: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of 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, Self: Sized,

Feeds a slice of this type into the given Hasher.

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

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,

Restrict a value to a certain interval.

impl PartialEq<&PathBuf> for Path

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

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

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

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

fn write_into<W: ByteWriter>(&self, target: &mut W)

Serializes self into bytes and writes these bytes into the target.

fn to_bytes(&self) -> Vec<u8>

Serializes self into a vector of bytes.

fn get_size_hint(&self) -> usize

Returns an estimate of how many bytes are needed to represent self.

impl<'a> TryFrom<&'a str> for PathBuf

type Error = PathError

The type returned in the event of a conversion error.

fn try_from(value: &'a str) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<String> for PathBuf

type Error = PathError

The type returned in the event of a conversion error.

fn try_from(value: String) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for PathBuf

impl StructuralPartialEq for PathBuf