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

# Struct syn::Path [−] [src]

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

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

### `impl Path` [src]

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

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

#### `pub fn is_ident<I: ?Sized>(&self, ident: &I) -> bool where
Ident: PartialEq<I>,` [src]

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())
        }
    }

#### `pub fn get_ident(&self) -> Option<&Ident>` [src]

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

### `impl Clone for Path` [src]

#### `fn clone(&self) -> Self` [src]

Returns a copy of the value. Read more

#### `pub fn clone_from(&mut self, source: &Self)`1.0.0 [src]

Performs copy-assignment from `source`. Read more

### `impl Debug for Path` [src]

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

Formats the value using the given formatter. Read more

### `impl Eq for Path` [src]

### `impl From<Path> for Meta` [src]

#### `fn from(e: Path) -> Meta` [src]

Performs the conversion.

### `impl<T> From<T> for Path where
T: Into<PathSegment>,` [src]

#### `fn from(segment: T) -> Self` [src]

Performs the conversion.

### `impl Hash for Path` [src]

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

Feeds this value into the given `Hasher`. Read more

#### `pub fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,` 1.3.0 [src]

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

### `impl Parse for Path` [src]

#### `fn parse(input: ParseStream<'_>) -> Result<Self>` [src]

### `impl PartialEq<Path> for Path` [src]

#### `fn eq(&self, other: &Self) -> bool` [src]

This method tests for `self` and `other` values to be equal, and is used by `==`. Read more

#### `#[must_use]pub fn ne(&self, other: &Rhs) -> bool` 1.0.0 [src]

This method tests for `!=`.

### `impl ToTokens for Path` [src]

#### `fn to_tokens(&self, tokens: &mut TokenStream)` [src]

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

#### `pub fn to_token_stream(&self) -> TokenStream` [src]

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

#### `pub fn into_token_stream(self) -> TokenStream` [src]

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

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

### `impl<T> Any for T where
T: 'static + ?Sized,` [src]

#### `pub fn type_id(&self) -> TypeId` [src]

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

### `impl<T> Borrow<T> for T where
T: ?Sized,` [src]

#### `pub fn borrow(&self) -> &T` [src]

Immutably borrows from an owned value. Read more

### `impl<T> BorrowMut<T> for T where
T: ?Sized,` [src]

#### `pub fn borrow_mut(&mut self) -> &mut T` [src]

Mutably borrows from an owned value. Read more

### `impl<T> From<T> for T` [src]

#### `pub fn from(t: T) -> T` [src]

Performs the conversion.

### `impl<T, U> Into<U> for T where
U: From<T>,` [src]

#### `pub fn into(self) -> U` [src]

Performs the conversion.

### `impl<T> Spanned for T where
T: Spanned + ?Sized,` [src]

#### `pub fn span(&Self) -> Span` [src]

Returns a `Span` covering the complete contents of this syntax tree node, or `Span::call_site()` if this node is empty. Read more

### `impl<T> ToOwned for T where
T: Clone,` [src]

#### `type Owned = T`

The resulting type after obtaining ownership.

#### `pub fn to_owned(&self) -> T` [src]

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

#### `pub fn clone_into(&self, target: &mut T)` [src]

🔬 This is a nightly-only experimental API. (`toowned_clone_into`)

recently added

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

### `impl<T, U> TryFrom<U> for T where
U: Into<T>,` [src]

#### `type Error = Infallible`

The type returned in the event of a conversion error.

#### `pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>` [src]

Performs the conversion.

### `impl<T, U> TryInto<U> for T where
U: TryFrom<T>,` [src]

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

The type returned in the event of a conversion error.

#### `pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>` [src]

Performs the conversion.