pub struct Path {
pub leading_colon: Option<Colon2>,
pub segments: Punctuated<PathSegment, Colon2>,
}
Expand description
A path at which a named item is exported (e.g. std::collections::HashMap
).
This type is available only if Syn is built with the "derive"
or "full"
feature.
Fields
leading_colon: Option<Colon2>
segments: Punctuated<PathSegment, Colon2>
Implementations
sourceimpl Path
impl Path
sourcepub fn parse_mod_style(input: ParseStream<'_>) -> Result<Self>
pub fn parse_mod_style(input: ParseStream<'_>) -> Result<Self>
Parse a Path
containing no path arguments on any of its segments.
This function is available only if Syn is built with the "parsing"
feature.
Example
use syn::{Path, Result, Token};
use syn::parse::{Parse, ParseStream};
// A simplified single `use` statement like:
//
// use std::collections::HashMap;
//
// Note that generic parameters are not allowed in a `use` statement
// so the following must not be accepted.
//
// use a::<b>::c;
struct SingleUse {
use_token: Token![use],
path: Path,
}
impl Parse for SingleUse {
fn parse(input: ParseStream) -> Result<Self> {
Ok(SingleUse {
use_token: input.parse()?,
path: input.call(Path::parse_mod_style)?,
})
}
}
sourcepub fn is_ident<I: ?Sized>(&self, ident: &I) -> bool where
Ident: PartialEq<I>,
pub fn is_ident<I: ?Sized>(&self, ident: &I) -> bool where
Ident: PartialEq<I>,
Determines whether this is a path of length 1 equal to the given ident.
For them to compare equal, it must be the case that:
- the path has no leading colon,
- the number of path segments is 1,
- the first path segment has no angle bracketed or parenthesized path arguments, and
- the ident of the first path segment is equal to the given one.
This function is available only if Syn is built with the "parsing"
feature.
Example
use syn::{Attribute, Error, Meta, NestedMeta, Result};
fn get_serde_meta_items(attr: &Attribute) -> Result<Vec<NestedMeta>> {
if attr.path.is_ident("serde") {
match attr.parse_meta()? {
Meta::List(meta) => Ok(Vec::from_iter(meta.nested)),
bad => Err(Error::new_spanned(bad, "unrecognized attribute")),
}
} else {
Ok(Vec::new())
}
}
sourcepub fn get_ident(&self) -> Option<&Ident>
pub fn get_ident(&self) -> Option<&Ident>
If this path consists of a single ident, returns the ident.
A path is considered an ident if:
- the path has no leading colon,
- the number of path segments is 1, and
- the first path segment has no angle bracketed or parenthesized path arguments.
This function is available only if Syn is built with the "parsing"
feature.
Trait Implementations
sourceimpl<T> From<T> for Path where
T: Into<PathSegment>,
impl<T> From<T> for Path where
T: Into<PathSegment>,
sourceimpl ToTokens for Path
impl ToTokens for Path
sourcefn to_tokens(&self, tokens: &mut TokenStream)
fn to_tokens(&self, tokens: &mut TokenStream)
Write self
to the given TokenStream
. Read more
sourcefn to_token_stream(&self) -> TokenStream
fn to_token_stream(&self) -> TokenStream
Convert self
directly into a TokenStream
object. Read more
sourcefn into_token_stream(self) -> TokenStream
fn into_token_stream(self) -> TokenStream
Convert self
directly into a TokenStream
object. Read more
impl Eq for Path
Auto Trait Implementations
impl RefUnwindSafe for Path
impl !Send for Path
impl !Sync for Path
impl Unpin for Path
impl UnwindSafe for Path
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Spanned for T where
T: Spanned + ?Sized,
impl<T> Spanned for T where
T: Spanned + ?Sized,
sourcefn span(&self) -> Span
fn span(&self) -> Span
Returns a Span
covering the complete contents of this syntax tree
node, or Span::call_site()
if this node is empty. Read more
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more