Struct LibraryPath

pub struct LibraryPath { /* private fields */ }

Path to a module or a procedure.

Implementations

impl LibraryPath

pub fn new(source: impl AsRef<str>) -> Result<LibraryPath, PathError>

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.
• The path prefix represents an invalid namespace, see LibraryNamespace for details.
• 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 new_from_components<I>( ns: LibraryNamespace, components: I, ) -> LibraryPath

where I: IntoIterator<Item = Ident>,

Create a LibraryPath from pre-validated components

impl LibraryPath

Path metadata

pub fn len(&self) -> usize

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

pub fn byte_len(&self) -> usize

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

pub fn path(&self) -> Cow<'_, str>

Returns the full path of the Library as a string

pub fn namespace(&self) -> &LibraryNamespace

Return the namespace component of this path

pub fn last(&self) -> &str

Returns the last component of the path as a str

pub fn last_component(&self) -> LibraryPathComponent<'_>

Returns the last component of the path.

pub fn num_components(&self) -> usize

Returns the number of components in the path.

This is guaranteed to return at least 1.

pub fn components(&self) -> impl Iterator<Item = LibraryPathComponent<'_>>

Returns an iterator over all components of the path.

pub fn is_kernel_path(&self) -> bool

Returns true if this path is for a kernel module.

pub fn is_exec_path(&self) -> bool

Returns true if this path is for an executable module.

pub fn is_anon_path(&self) -> bool

Returns true if this path is for an anonymous module.

pub fn starts_with(&self, other: &LibraryPath) -> bool

Returns true if self starts with other

impl LibraryPath

Mutation

pub fn set_namespace(&mut self, ns: LibraryNamespace)

Override the current LibraryNamespace for this path.

pub fn join(&self, other: &LibraryPath) -> Result<LibraryPath, PathError>

Appends the provided path to this path and returns the result.

Errors

Returns an error if the join would produce an invalid path. For example, paths with reserved namespaces may not be joined to other paths.

pub fn push(&mut self, component: impl AsRef<str>) -> Result<(), PathError>

Append the given component to this path.

Returns an error if the component is not valid.

pub fn push_ident(&mut self, component: Ident)

Append an Ident as a component to this path

pub fn append<S>(&self, component: S) -> Result<LibraryPath, PathError>

where S: AsRef<str>,

Appends the provided component to the end of this path and returns the result.

Returns an error if the input string is not a valid component.

pub fn append_ident(&self, component: Ident) -> Result<LibraryPath, PathError>

Appends the provided component to the end of this path and returns the result.

Returns an error if the input string is not a valid component.

pub fn prepend<S>(&self, component: S) -> Result<LibraryPath, PathError>

where S: AsRef<str>,

Adds the provided component to the front of this path and returns the result.

Errors

Returns an error if:

• The input string is not a valid LibraryNamespace
• The current namespace is a reserved identifier and therefore not a valid path component

pub fn pop(&mut self) -> Option<Ident>

Pops the last non-namespace component in this path

pub fn strip_last(&self) -> Option<LibraryPath>

Returns a new path, representing the current one with the last non-namespace component removed.

pub fn validate<S>(source: S) -> Result<usize, PathError>

where S: AsRef<str>,

Checks if the given input string is a valid LibraryPath, returning the number of components in the path.

See the documentation of LibraryPath::new for details on what constitutes a valid path.

pub fn append_unchecked<S>(&self, component: S) -> LibraryPath

where S: AsRef<str>,

Returns a new LibraryPath with the given component appended without any validation.

The caller is expected to uphold the validity invariants of LibraryPath.

Trait Implementations

impl Clone for LibraryPath

fn clone(&self) -> LibraryPath

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LibraryPath

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

Formats the value using the given formatter.

impl Default for LibraryPath

fn default() -> LibraryPath

Returns the “default value” for a type.

impl Deserializable for LibraryPath

fn read_from<R>(source: &mut R) -> Result<LibraryPath, 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 LibraryPath

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

Formats the value using the given formatter.

impl From<LibraryNamespace> for LibraryPath

fn from(ns: LibraryNamespace) -> LibraryPath

Converts to this type from the input type.

impl FromStr for LibraryPath

type Err = PathError

The associated error which can be returned from parsing.

fn from_str(value: &str) -> Result<LibraryPath, <LibraryPath as FromStr>::Err>

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

impl Hash for LibraryPath

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 Ord for LibraryPath

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

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

fn partial_cmp(&self, other: &LibraryPath) -> 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 LibraryPath

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 LibraryPath

type Error = PathError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<String> for LibraryPath

type Error = PathError

The type returned in the event of a conversion error.

fn try_from( value: String, ) -> Result<LibraryPath, <LibraryPath as TryFrom<String>>::Error>

Performs the conversion.

impl<'a> TryFrom<Vec<LibraryPathComponent<'a>>> for LibraryPath

type Error = PathError

The type returned in the event of a conversion error.

fn try_from( iter: Vec<LibraryPathComponent<'a>>, ) -> Result<LibraryPath, <LibraryPath as TryFrom<Vec<LibraryPathComponent<'a>>>>::Error>

Performs the conversion.

impl Eq for LibraryPath

impl StructuralPartialEq for LibraryPath