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) -> PathBuf

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

pub fn new<S>(source: &S) -> Result<PathBuf, 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) -> PathBuf

where S: AsRef<str> + ?Sized,

Create an absolute Path from a pre-validated string

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

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, and that each component is in canonical form.

pub fn push_component<S>(&mut self, component: &S)

where S: AsRef<str> + ?Sized,

Extends self with component.

Unlike Self::push, which appends another Path to the buffer - this method appends the given string as a single path component, ensuring that the content is quoted properly if needed.

If :: is pushed, it is treated as a literal root component (i.e. it makes the path absolute). On a non-empty PathBuf, this has the effect of clearing the path, similar to what happens if you call PathBuf::push with an absolute path.

Pushing components using this method guarantees they are in canonical form.

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

pub const EMPTY: &'static Path

pub const KERNEL_PATH: &'static str = "$kernel"

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

pub const KERNEL: &'static Path

pub const EXEC_PATH: &'static str = "$exec"

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

pub const EXEC: &'static 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 is_in_exec(&self) -> bool

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

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

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

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

The matching semantics of Prefix depend on the implementation of StartsWith<Prefix>, in particular, if Prefix is str, then the prefix is matched against the first non-root component of self, regardless of whether the string contains path delimiters (i.e. ::).

See the StartsWith trait for more details.

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

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

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

The matching semantics of Prefix depend on the implementation of StartsWith<Prefix>, in particular, if Prefix is str, then the prefix is matched against the first component of self, regardless of whether the string contains path delimiters (i.e. ::).

See the StartsWith trait for more details.

pub fn strip_prefix<'a>(&'a self, prefix: &Path) -> Option<&'a Path>

Strips prefix from self, or returns None if self does not start with prefix.

NOTE: Prefixes must be exact, i.e. if you call path.strip_prefix(prefix) and path is relative but prefix is absolute, then this will return None. The same is true if path is absolute and prefix is relative.

pub fn join<P>(&self, other: &P) -> PathBuf

where Path: Join<P>, P: ?Sized,

Create an owned PathBuf with path adjoined to self.

If path is absolute, it replaces the current path.

The semantics of how other is joined to self in the resulting path depends on the implementation of Join used. The implementation for Path and PathBuf joins all components of other to self; while the implementation for [prim@str], string-like values, and identifiers/symbols joins just a single component. You must be careful to ensure that if you are passing a string here, that you specifically want to join it as a single component, or the resulting path may be different than you expect. It is recommended that you use Path::new(&string)` if you want to be explicit about treating a string-like value as a multi-component path.

pub fn canonicalize(&self) -> Result<PathBuf, PathError>

Canonicalize this path by ensuring that all components are in canonical form.

Canonical form dictates that:

• A component is quoted only if it requires quoting, and unquoted otherwise
• Is made absolute if relative and the first component is $kernel or $exec

Returns Err if the path is invalid

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<(), Error>

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) -> &<PathBuf as Deref>::Target

Dereferences the value.

impl Deserializable for PathBuf

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

where R: ByteReader,

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<(), Error>

Formats the value using the given formatter.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl From<Ident> for PathBuf

fn from(component: Ident) -> PathBuf

Converts to this type from the input type.

impl From<PathBuf> for QualifiedProcedureName

fn from(path: PathBuf) -> QualifiedProcedureName

Converts to this type from the input type.

impl From<PathBuf> for String

fn from(path: PathBuf) -> String

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<PathBuf, <PathBuf as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for PathBuf

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

where __H: Hasher,

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 Join<Arc<str>> for PathBuf

fn join(&self, other: &Arc<str>) -> PathBuf

Joins other to self, producing a new PathBuf containing the joined path.

impl Join<Box<str>> for PathBuf

fn join(&self, other: &Box<str>) -> PathBuf

Joins other to self, producing a new PathBuf containing the joined path.

impl Join<Ident> for PathBuf

fn join(&self, other: &Ident) -> PathBuf

Joins other to self, producing a new PathBuf containing the joined path.

impl Join<Path> for PathBuf

fn join(&self, other: &Path) -> PathBuf

Joins other to self, producing a new PathBuf containing the joined path.

impl Join<PathBuf> for Path

fn join(&self, other: &PathBuf) -> PathBuf

Joins other to self, producing a new PathBuf containing the joined path.

impl Join<PathBuf> for PathBuf

fn join(&self, other: &PathBuf) -> PathBuf

Joins other to self, producing a new PathBuf containing the joined path.

impl Join<ProcedureName> for PathBuf

fn join(&self, other: &ProcedureName) -> PathBuf

Joins other to self, producing a new PathBuf containing the joined path.

impl Join<QualifiedProcedureName> for PathBuf

fn join(&self, other: &QualifiedProcedureName) -> PathBuf

Joins other to self, producing a new PathBuf containing the joined path.

impl Join<String> for PathBuf

fn join(&self, other: &String) -> PathBuf

Joins other to self, producing a new PathBuf containing the joined path.

impl Join<str> for PathBuf

fn join(&self, other: &str) -> PathBuf

Joins other to self, producing a new PathBuf containing the joined path.

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>(&self, target: &mut W)

where W: ByteWriter,

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<PathBuf, <PathBuf as TryFrom<&'a str>>::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<PathBuf, <PathBuf as TryFrom<String>>::Error>

Performs the conversion.

impl Eq for PathBuf

impl StructuralPartialEq for PathBuf