Struct QualifiedProcedureName 

pub struct QualifiedProcedureName { /* private fields */ }

Represents a qualified procedure name, e.g. std::math::u64::add, parsed into it’s constituent Path and ProcedureName components.

A qualified procedure name can be context-sensitive, i.e. the module path might refer to an imported

Implementations

impl QualifiedProcedureName

pub fn new(module: impl AsRef<Path>, name: ProcedureName) -> Self

Create a new QualifiedProcedureName with the given fully-qualified module path and procedure name.

pub fn with_span(self, span: SourceSpan) -> Self

pub fn namespace(&self) -> &Path

Get the module/namespace of this procedure

pub fn name(&self) -> &str

Get the name of this procedure as a str

pub fn as_path(&self) -> &Path

Get this QualifiedProcedureName as a Path

pub fn to_spanned_path(&self) -> Span<&Path>

Get this QualifiedProcedureName as a Span<&Path>

pub fn into_inner(self) -> Arc<Path>

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 AsRef<Path> for QualifiedProcedureName

fn as_ref(&self) -> &Path

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

impl Clone for QualifiedProcedureName

fn clone(&self) -> QualifiedProcedureName

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for QualifiedProcedureName

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

Formats the value using the given formatter.

impl Deref for QualifiedProcedureName

type Target = Path

The resulting type after dereferencing.

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

Dereferences the value.

impl Display for QualifiedProcedureName

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

Formats the value using the given formatter.

impl From<&Path> for QualifiedProcedureName

fn from(path: &Path) -> Self

Converts to this type from the input type.

impl From<Arc<Path>> for QualifiedProcedureName

fn from(path: Arc<Path>) -> 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<QualifiedProcedureName> for Arc<Path>

fn from(value: QualifiedProcedureName) -> Self

Converts to this type from the input type.

impl From<QualifiedProcedureName> for SourceSpan

fn from(fqn: QualifiedProcedureName) -> Self

Converts to this type from the input type.

impl FromStr for QualifiedProcedureName

type Err = Report

The associated error which can be returned from parsing.

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

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

impl Ord for QualifiedProcedureName

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

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

fn partial_cmp(&self, other: &Self) -> 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 PrettyPrint for QualifiedProcedureName

fn render(&self) -> Document

The core of the PrettyPrint functionality.

fn to_pretty_string(&self) -> String

Produce a String containing the results of pretty-printing this object.

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

Pretty-print this object to the given core::fmt::Formatter.

impl Spanned for QualifiedProcedureName

fn span(&self) -> SourceSpan

impl TryFrom<&str> for QualifiedProcedureName

type Error = Report

The type returned in the event of a conversion error.

fn try_from(name: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<String> for QualifiedProcedureName

type Error = Report

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Eq for QualifiedProcedureName