# Struct syn::Path

source · [−]

    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

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.

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

source

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

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.

This function is available only if Syn is built with the `"parsing"` feature.

## 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 From<Path> for Meta

source

#### fn from(e: 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 Parse for Path

source

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

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

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

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,

const: unstable · source

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

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Returns the argument unchanged.

source

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

const: unstable · 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. Read more

source

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

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

#### type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · 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>,

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

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.