      1
      2
      3
      4
      5
      6
      7
      8
      9
     10
     11
     12
     13
     14
     15
     16
     17
     18
     19
     20
     21
     22
     23
     24
     25
     26
     27
     28
     29
     30
     31
     32
     33
     34
     35
     36
     37
     38
     39
     40
     41
     42
     43
     44
     45
     46
     47
     48
     49
     50
     51
     52
     53
     54
     55
     56
     57
     58
     59
     60
     61
     62
     63
     64
     65
     66
     67
     68
     69
     70
     71
     72
     73
     74
     75
     76
     77
     78
     79
     80
     81
     82
     83
     84
     85
     86
     87
     88
     89
     90
     91
     92
     93
     94
     95
     96
     97
     98
     99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    146
    147
    148
    149
    150
    151
    152
    153
    154
    155
    156
    157
    158
    159
    160
    161
    162
    163
    164
    165
    166
    167
    168
    169
    170
    171
    172
    173
    174
    175
    176
    177
    178
    179
    180
    181
    182
    183
    184
    185
    186
    187
    188
    189
    190
    191
    192
    193
    194
    195
    196
    197
    198
    199
    200
    201
    202
    203
    204
    205
    206
    207
    208
    209
    210
    211

    #![doc(html_root_url = "https://dtolnay.github.io/syn")]

    #![cfg_attr(feature = "cargo-clippy", allow(large_enum_variant))]

    #[cfg(feature = "printing")]
    extern crate quote;

    #[cfg(feature = "parsing")]
    extern crate unicode_xid;

    #[cfg(feature = "parsing")]
    #[macro_use]
    extern crate synom;

    #[cfg(feature = "aster")]
    pub mod aster;

    mod attr;
    pub use attr::{Attribute, AttrStyle, MetaItem, NestedMetaItem};

    mod constant;
    pub use constant::ConstExpr;

    mod data;
    pub use data::{Field, Variant, VariantData, Visibility};

    #[cfg(feature = "parsing")]
    mod escape;

    #[cfg(feature = "full")]
    mod expr;
    #[cfg(feature = "full")]
    pub use expr::{Arm, BindingMode, Block, CaptureBy, Expr, ExprKind, FieldPat, FieldValue, Local,
                   MacStmtStyle, Pat, RangeLimits, Stmt};

    mod generics;
    pub use generics::{Generics, Lifetime, LifetimeDef, TraitBoundModifier, TyParam, TyParamBound,
                       WhereBoundPredicate, WhereClause, WhereEqPredicate, WherePredicate,
                       WhereRegionPredicate};
    #[cfg(feature = "printing")]
    pub use generics::{ImplGenerics, Turbofish, TyGenerics};

    mod ident;
    pub use ident::Ident;

    #[cfg(feature = "full")]
    mod item;
    #[cfg(feature = "full")]
    pub use item::{Constness, Defaultness, FnArg, FnDecl, ForeignItemKind, ForeignItem, ForeignMod,
                   ImplItem, ImplItemKind, ImplPolarity, Item, ItemKind, MethodSig, PathListItem,
                   TraitItem, TraitItemKind, ViewPath};

    #[cfg(feature = "full")]
    mod krate;
    #[cfg(feature = "full")]
    pub use krate::Crate;

    mod lit;
    pub use lit::{FloatTy, IntTy, Lit, StrStyle};
    #[cfg(feature = "parsing")]
    pub use lit::{ByteStrLit, FloatLit, IntLit, StrLit};

    mod mac;
    pub use mac::{BinOpToken, DelimToken, Delimited, Mac, Token, TokenTree};

    mod derive;
    pub use derive::{Body, DeriveInput};
    // Deprecated. Use `DeriveInput` instead.
    #[doc(hidden)]
    pub type MacroInput = DeriveInput;

    mod op;
    pub use op::{BinOp, UnOp};

    mod ty;
    pub use ty::{Abi, AngleBracketedParameterData, BareFnArg, BareFnTy, FunctionRetTy, MutTy,
                 Mutability, ParenthesizedParameterData, Path, PathParameters, PathSegment,
                 PolyTraitRef, QSelf, Ty, TypeBinding, Unsafety};

    #[cfg(feature = "visit")]
    pub mod visit;

    #[cfg(feature = "fold")]
    pub mod fold;

    #[cfg(feature = "parsing")]
    pub use parsing::*;

    #[cfg(feature = "parsing")]
    mod parsing {
        use super::*;
        use {derive, generics, ident, mac, ty, attr};
        use synom::{space, IResult};

        #[cfg(feature = "full")]
        use {expr, item, krate};

        pub fn parse_derive_input(input: &str) -> Result<DeriveInput, String> {
            unwrap("derive input", derive::parsing::derive_input, input)
        }

        #[cfg(feature = "full")]
        pub fn parse_crate(input: &str) -> Result<Crate, String> {
            unwrap("crate", krate::parsing::krate, input)
        }

        #[cfg(feature = "full")]
        pub fn parse_item(input: &str) -> Result<Item, String> {
            unwrap("item", item::parsing::item, input)
        }

        #[cfg(feature = "full")]
        pub fn parse_items(input: &str) -> Result<Vec<Item>, String> {
            unwrap("items", item::parsing::items, input)
        }

        #[cfg(feature = "full")]
        pub fn parse_expr(input: &str) -> Result<Expr, String> {
            unwrap("expression", expr::parsing::expr, input)
        }

        pub fn parse_type(input: &str) -> Result<Ty, String> {
            unwrap("type", ty::parsing::ty, input)
        }

        pub fn parse_path(input: &str) -> Result<Path, String> {
            unwrap("path", ty::parsing::path, input)
        }

        pub fn parse_where_clause(input: &str) -> Result<WhereClause, String> {
            unwrap("where clause", generics::parsing::where_clause, input)
        }

        pub fn parse_token_trees(input: &str) -> Result<Vec<TokenTree>, String> {
            unwrap("token trees", mac::parsing::token_trees, input)
        }

        pub fn parse_ident(input: &str) -> Result<Ident, String> {
            unwrap("identifier", ident::parsing::ident, input)
        }

        pub fn parse_ty_param_bound(input: &str) -> Result<TyParamBound, String> {
            unwrap("type parameter bound",
                   generics::parsing::ty_param_bound,
                   input)
        }

        pub fn parse_outer_attr(input: &str) -> Result<Attribute, String> {
            unwrap("outer attribute", attr::parsing::outer_attr, input)
        }

        #[cfg(feature = "full")]
        pub fn parse_inner_attr(input: &str) -> Result<Attribute, String> {
            unwrap("inner attribute", attr::parsing::inner_attr, input)
        }

        // Deprecated. Use `parse_derive_input` instead.
        #[doc(hidden)]
        pub fn parse_macro_input(input: &str) -> Result<MacroInput, String> {
            parse_derive_input(input)
        }

        fn unwrap<T>(name: &'static str,
                     f: fn(&str) -> IResult<&str, T>,
                     input: &str)
                     -> Result<T, String> {
            match f(input) {
                IResult::Done(mut rest, t) => {
                    rest = space::skip_whitespace(rest);
                    if rest.is_empty() {
                        Ok(t)
                    } else if rest.len() == input.len() {
                        // parsed nothing
                        Err(format!("failed to parse {}: {:?}", name, rest))
                    } else {
                        Err(format!("unparsed tokens after {}: {:?}", name, rest))
                    }
                }
                IResult::Error => Err(format!("failed to parse {}: {:?}", name, input)),
            }
        }
    }

    #[cfg(feature = "parsing")]
    pub mod parse {
        //! This module contains a set of exported nom parsers which can be used to
        //! parse custom grammars when used alongside the `synom` crate.
        //!
        //! Internally, `syn` uses a fork of `nom` called `synom` which resolves a
        //! persistent pitfall of using `nom` to parse Rust by eliminating the
        //! `IResult::Incomplete` variant. The `synom` crate should be used instead
        //! of `nom` when working with the parsers in this module.

        pub use synom::IResult;

        #[cfg(feature = "full")]
        pub use item::parsing::item;

        #[cfg(feature = "full")]
        pub use expr::parsing::{expr, pat, block, stmt};

        pub use lit::parsing::{lit, string, byte_string, byte, character, float, int, boolean};

        pub use ty::parsing::{ty, path};

        pub use mac::parsing::token_tree as tt;

        pub use ident::parsing::ident;

        pub use generics::parsing::lifetime;
    }

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)