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,

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