# Path in syn - Rust
A path at which a named item is exported (e.g. `std::collections::HashMap`).

syn

# Struct Path

Source

    pub struct Path {
        pub leading_colon: Option<PathSep>,
        pub segments: Punctuated<PathSegment, PathSep>,
    }

Expand description

A path at which a named item is exported (e.g. `std::collections::HashMap`).

## Fields§

§ `leading_colon: Option<PathSep>` § `segments: Punctuated<PathSegment, PathSep>`

## Implementations§

Source §

### impl Path

Source

#### pub fn parse_mod_style(input: ParseStream<'_>) -> Result<Self>

Parse a `Path` containing no path arguments on any of its segments.

##### §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)?,
            })
        }
    }

Source §

### impl Path

Source

#### pub fn is_ident<I>(&self, ident: &I) -> bool
where I: ?Sized, 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.

##### §Example

    use proc_macro2::TokenStream;
    use syn::{Attribute, Error, Meta, Result};

    fn get_serde_meta_item(attr: &Attribute) -> Result<Option<&TokenStream>> {
        if attr.path().is_ident("serde") {
            match &attr.meta {
                Meta::List(meta) => Ok(Some(&meta.tokens)),
                bad => Err(Error::new_spanned(bad, "unrecognized attribute")),
            }
        } else {
            Ok(None)
        }
    }

Source

#### 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.

Source

#### pub fn require_ident(&self) -> Result<&Ident>

An error if this path is not a single ident, as defined in `get_ident`.

## Trait Implementations§

Source §

### impl Clone for Path

Source §

#### fn clone(&self) -> Self

Returns a copy of the value. Read more
1.0.0 · Source §

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

Performs copy-assignment from `source`. Read more
Source §

### impl Debug for Path

Source §

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

Formats the value using the given formatter. Read more
Source §

### impl From<Path> for Meta

Source §

#### fn from(meta: Path) -> Meta

Converts to this type from the input type.
Source §

### impl<T> From<T> for Path
where T: Into<PathSegment>,

Source §

#### fn from(segment: T) -> Self

Converts to this type from the input type.
Source §

### impl Hash for Path

Source §

#### fn hash<H>(&self, state: &mut H)
where H: Hasher,

Feeds this value into the given `Hasher`. Read more
1.3.0 · Source §

#### fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given `Hasher`. Read more
Source §

### impl Parse for Path

Source §

#### fn parse(input: ParseStream<'_>) -> Result<Self>

Source §

### impl PartialEq for Path

Source §

#### fn eq(&self, other: &Self) -> bool

Tests for `self` and `other` values to be equal, and is used by `==`.
1.0.0 · Source §

#### fn ne(&self, other: &Rhs) -> bool

Tests for `!=`. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source §

### impl ToTokens for Path

Source §

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

Write `self` to the given `TokenStream`. Read more
Source §

#### fn to_token_stream(&self) -> TokenStream

Convert `self` directly into a `TokenStream` object. Read more
Source §

#### fn into_token_stream(self) -> TokenStream
where Self: Sized,

Convert `self` directly into a `TokenStream` object. Read more
Source §

### impl Eq for Path

## Auto Trait Implementations§

§

### impl Freeze for Path

§

### impl RefUnwindSafe for Path

§

### impl !Send for Path

§

### impl !Sync for Path

§

### impl Unpin for Path

§

### impl UnwindSafe for Path

## Blanket Implementations§

Source §

### impl<T> Any for T
where T: 'static + ?Sized,

Source §

#### fn type_id(&self) -> TypeId

Gets the `TypeId` of `self`. Read more
Source §

### impl<T> Borrow<T> for T
where T: ?Sized,

Source §

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source §

### impl<T> BorrowMut<T> for T
where T: ?Sized,

Source §

#### fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source §

### impl<T> CloneToUninit for T
where T: Clone,

Source §

#### unsafe fn clone_to_uninit(&self, dst: *mut u8)

🔬This is a nightly-only experimental API. (`clone_to_uninit`)
Performs copy-assignment from `self` to `dst`. Read more
Source §

### impl<T> From<T> for T

Source §

#### fn from(t: T) -> T

Returns the argument unchanged.

Source §

### impl<T, U> Into<U> for T
where U: From<T>,

Source §

#### fn into(self) -> U

Calls `U::from(self)`.

That is, this conversion is whatever the implementation of `From<T> for U` chooses to do.

Source §

### impl<T> Spanned for T
where T: Spanned + ?Sized,

Source §

#### 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.
Source §

### impl<T> ToOwned for T
where T: Clone,

Source §

#### type Owned = T

The resulting type after obtaining ownership.
Source §

#### fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source §

#### fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source §

### impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source §

#### type Error = Infallible

The type returned in the event of a conversion error.
Source §

#### fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source §

### impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source §

#### type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source §

#### fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.