Struct IdentPath

pub struct IdentPath { /* private fields */ }

Represents an identifier path.

A identifier path is the full path of a specific identifier in the code, like std::str::FromStr. The identified object can be a constant, a type, a trait or anything else that is defined within a module.

The identifier path contains two parts:

• The identifier itself, which is more or less the name of the object to identify, and
• the math of the module the object is provided at.

Implementations

impl IdentPath

pub fn from_parts<I>(path: I, ident: Ident2) -> Self

where I: IntoIterator<Item = Ident2>,

Crates a new IdentPath instance from the passed module path and the identifier of the object to refer to.

pub fn from_ident(ident: Ident2) -> Self

Creates a new IdentPath from the passed object identifier without a module path.

pub fn with_ident(self, ident: Ident2) -> Self

Changes the identifier of this identifier path to the passed ident.

pub fn with_path<I>(self, path: I) -> Self

where I: IntoIterator<Item = Ident2>,

Changes the module path of this identifier path to the passed path.

pub fn into_parts(self) -> (Ident2, Option<ModulePath>)

Splits this identifier path into it’s two main parts, the identifier and the module path.

pub fn ident(&self) -> &Ident2

Returns the identifier of this identifier path.

pub fn relative_to(&self, dst: &ModulePath) -> TokenStream

Creates a new IdentPath that is relative to the passed dst module path.

This uses the super keyword to create a relative path from the passed dst module path and this identifier path. The relative path is returned as token stream.

Trait Implementations

impl Clone for IdentPath

fn clone(&self) -> IdentPath

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IdentPath

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

Formats the value using the given formatter.

impl FromStr for IdentPath

type Err = InvalidIdentPath

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 PartialEq for IdentPath

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

fn to_tokens(&self, tokens: &mut TokenStream)

Write self to the given TokenStream.

fn to_token_stream(&self) -> TokenStream

Convert self directly into a TokenStream object.

fn into_token_stream(self) -> TokenStream

where Self: Sized,

Convert self directly into a TokenStream object.

impl TryFrom<&str> for IdentPath

type Error = InvalidIdentPath

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<String> for IdentPath

type Error = InvalidIdentPath

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 IdentPath

impl StructuralPartialEq for IdentPath