2024-07-26 09:42:18 +00:00
<!DOCTYPE html> < html lang = "en" > < head > < meta charset = "utf-8" > < meta name = "viewport" content = "width=device-width, initial-scale=1.0" > < meta name = "generator" content = "rustdoc" > < meta name = "description" content = "Parser that can parse Rust tokens into a particular syntax tree node." > < title > Parser in syn::parse - Rust< / title > < script > if ( window . location . protocol !== "file:" ) document . head . insertAdjacentHTML ( "beforeend" , "SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2" . split ( "," ) . map ( f => ` <link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/ ${ f } "> ` ) . join ( "" ) ) < / script > < link rel = "stylesheet" href = "../../static.files/normalize-76eba96aa4d2e634.css" > < link rel = "stylesheet" href = "../../static.files/rustdoc-dd39b87e5fcfba68.css" > < meta name = "rustdoc-vars" data-root-path = "../../" data-static-root-path = "../../static.files/" data-current-crate = "syn" data-themes = "" data-resource-suffix = "" data-rustdoc-version = "1.80.0 (051478957 2024-07-21)" data-channel = "1.80.0" data-search-js = "search-d52510db62a78183.js" data-settings-js = "settings-4313503d2e1961c2.js" > < script src = "../../static.files/storage-118b08c4c78b968e.js" > < / script > < script defer src = "sidebar-items.js" > < / script > < script defer src = "../../static.files/main-20a3ad099b048cf2.js" > < / script > < noscript > < link rel = "stylesheet" href = "../../static.files/noscript-df360f571f6edeae.css" > < / noscript > < link rel = "alternate icon" type = "image/png" href = "../../static.files/favicon-32x32-422f7d1d52889060.png" > < link rel = "icon" type = "image/svg+xml" href = "../../static.files/favicon-2c020d218678b618.svg" > < / head > < body class = "rustdoc trait" > <!-- [if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif] --> < nav class = "mobile-topbar" > < button class = "sidebar-menu-toggle" title = "show sidebar" > < / button > < / nav > < nav class = "sidebar" > < div class = "sidebar-crate" > < h2 > < a href = "../../syn/index.html" > syn< / a > < span class = "version" > 2.0.72< / span > < / h2 > < / div > < h2 class = "location" > < a href = "#" > Parser< / a > < / h2 > < div class = "sidebar-elems" > < section > < h3 > < a href = "#required-associated-types" > Required Associated Types< / a > < / h3 > < ul class = "block" > < li > < a href = "#associatedtype.Output" > Output< / a > < / li > < / ul > < h3 > < a href = "#required-methods" > Required Methods< / a > < / h3 > < ul class = "block" > < li > < a href = "#tymethod.parse2" > parse2< / a > < / li > < / ul > < h3 > < a href = "#provided-methods" > Provided Methods< / a > < / h3 > < ul class = "block" > < li > < a href = "#method.parse" > parse< / a > < / li > < li > < a href = "#method.parse_str" > parse_str< / a > < / li > < / ul > < h3 > < a href = "#object-safety" > Object Safety< / a > < / h3 > < h3 > < a href = "#implementors" > Implementors< / a > < / h3 > < / section > < h2 > < a href = "index.html" > In syn::parse< / a > < / h2 > < / div > < / nav > < div class = "sidebar-resizer" > < / div > < main > < div class = "width-limiter" > < rustdoc-search > < / rustdoc-search > < section id = "main-content" class = "content" > < div class = "main-heading" > < h1 > Trait < a href = "../index.html" > syn< / a > ::< wbr > < a href = "index.html" > parse< / a > ::< wbr > < a class = "trait" href = "#" > Parser< / a > < button id = "copy-path" title = "Copy item path to clipboard" > Copy item path< / button > < / h1 > < span class = "out-of-band" > < a class = "src" href = "../../src/syn/parse.rs.html#1233-1271" > source< / a > · < button id = "toggle-all-docs" title = "collapse all docs" > [< span > − < / span > ]< / button > < / span > < / div > < pre class = "rust item-decl" > < code > pub trait Parser: < a class = "trait" href = "https://doc.rust-lang.org/1.80.0/core/marker/trait.Sized.html" title = "trait core::marker::Sized" > Sized< / a > {
2024-02-13 06:38:44 +00:00
type < a href = "#associatedtype.Output" class = "associatedtype" > Output< / a > ;
// Required method
fn < a href = "#tymethod.parse2" class = "fn" > parse2< / a > (self, tokens: < a class = "struct" href = "../../proc_macro2/struct.TokenStream.html" title = "struct proc_macro2::TokenStream" > TokenStream< / a > ) -> < a class = "type" href = "type.Result.html" title = "type syn::parse::Result" > Result< / a > < Self::< a class = "associatedtype" href = "trait.Parser.html#associatedtype.Output" title = "type syn::parse::Parser::Output" > Output< / a > > ;
// Provided methods
2024-07-26 09:42:18 +00:00
fn < a href = "#method.parse" class = "fn" > parse< / a > (self, tokens: < a class = "struct" href = "https://doc.rust-lang.org/1.80.0/proc_macro/struct.TokenStream.html" title = "struct proc_macro::TokenStream" > TokenStream< / a > ) -> < a class = "type" href = "type.Result.html" title = "type syn::parse::Result" > Result< / a > < Self::< a class = "associatedtype" href = "trait.Parser.html#associatedtype.Output" title = "type syn::parse::Parser::Output" > Output< / a > > { ... }
< span class = "item-spacer" > < / span > fn < a href = "#method.parse_str" class = "fn" > parse_str< / a > (self, s: & < a class = "primitive" href = "https://doc.rust-lang.org/1.80.0/std/primitive.str.html" > str< / a > ) -> < a class = "type" href = "type.Result.html" title = "type syn::parse::Result" > Result< / a > < Self::< a class = "associatedtype" href = "trait.Parser.html#associatedtype.Output" title = "type syn::parse::Parser::Output" > Output< / a > > { ... }
2024-02-13 06:38:44 +00:00
}< / code > < / pre > < details class = "toggle top-doc" open > < summary class = "hideme" > < span > Expand description< / span > < / summary > < div class = "docblock" > < p > Parser that can parse Rust tokens into a particular syntax tree node.< / p >
< p > Refer to the < a href = "index.html" title = "mod syn::parse" > module documentation< / a > for details about parsing in Syn.< / p >
2024-07-26 09:42:18 +00:00
< / div > < / details > < h2 id = "required-associated-types" class = "section-header" > Required Associated Types< a href = "#required-associated-types" class = "anchor" > §< / a > < / h2 > < div class = "methods" > < section id = "associatedtype.Output" class = "method" > < a class = "src rightside" href = "../../src/syn/parse.rs.html#1234" > source< / a > < h4 class = "code-header" > type < a href = "#associatedtype.Output" class = "associatedtype" > Output< / a > < / h4 > < / section > < / div > < h2 id = "required-methods" class = "section-header" > Required Methods< a href = "#required-methods" class = "anchor" > §< / a > < / h2 > < div class = "methods" > < details class = "toggle method-toggle" open > < summary > < section id = "tymethod.parse2" class = "method" > < a class = "src rightside" href = "../../src/syn/parse.rs.html#1240" > source< / a > < h4 class = "code-header" > fn < a href = "#tymethod.parse2" class = "fn" > parse2< / a > (self, tokens: < a class = "struct" href = "../../proc_macro2/struct.TokenStream.html" title = "struct proc_macro2::TokenStream" > TokenStream< / a > ) -> < a class = "type" href = "type.Result.html" title = "type syn::parse::Result" > Result< / a > < Self::< a class = "associatedtype" href = "trait.Parser.html#associatedtype.Output" title = "type syn::parse::Parser::Output" > Output< / a > > < / h4 > < / section > < / summary > < div class = "docblock" > < p > Parse a proc-macro2 token stream into the chosen syntax tree node.< / p >
2024-02-13 06:38:44 +00:00
< p > This function will check that the input is fully parsed. If there are
any unparsed tokens at the end of the stream, an error is returned.< / p >
2024-07-26 09:42:18 +00:00
< / div > < / details > < / div > < h2 id = "provided-methods" class = "section-header" > Provided Methods< a href = "#provided-methods" class = "anchor" > §< / a > < / h2 > < div class = "methods" > < details class = "toggle method-toggle" open > < summary > < section id = "method.parse" class = "method" > < a class = "src rightside" href = "../../src/syn/parse.rs.html#1248-1250" > source< / a > < h4 class = "code-header" > fn < a href = "#method.parse" class = "fn" > parse< / a > (self, tokens: < a class = "struct" href = "https://doc.rust-lang.org/1.80.0/proc_macro/struct.TokenStream.html" title = "struct proc_macro::TokenStream" > TokenStream< / a > ) -> < a class = "type" href = "type.Result.html" title = "type syn::parse::Result" > Result< / a > < Self::< a class = "associatedtype" href = "trait.Parser.html#associatedtype.Output" title = "type syn::parse::Parser::Output" > Output< / a > > < / h4 > < / section > < / summary > < div class = "docblock" > < p > Parse tokens of source code into the chosen syntax tree node.< / p >
2024-02-13 06:38:44 +00:00
< p > This function will check that the input is fully parsed. If there are
any unparsed tokens at the end of the stream, an error is returned.< / p >
2024-07-26 09:42:18 +00:00
< / div > < / details > < details class = "toggle method-toggle" open > < summary > < section id = "method.parse_str" class = "method" > < a class = "src rightside" href = "../../src/syn/parse.rs.html#1261-1263" > source< / a > < h4 class = "code-header" > fn < a href = "#method.parse_str" class = "fn" > parse_str< / a > (self, s: & < a class = "primitive" href = "https://doc.rust-lang.org/1.80.0/std/primitive.str.html" > str< / a > ) -> < a class = "type" href = "type.Result.html" title = "type syn::parse::Result" > Result< / a > < Self::< a class = "associatedtype" href = "trait.Parser.html#associatedtype.Output" title = "type syn::parse::Parser::Output" > Output< / a > > < / h4 > < / section > < / summary > < div class = "docblock" > < p > Parse a string of Rust code into the chosen syntax tree node.< / p >
2024-02-13 06:38:44 +00:00
< p > This function will check that the input is fully parsed. If there are
any unparsed tokens at the end of the string, an error is returned.< / p >
2024-03-27 11:12:16 +00:00
< h5 id = "hygiene" > < a class = "doc-anchor" href = "#hygiene" > §< / a > Hygiene< / h5 >
2024-02-13 06:38:44 +00:00
< p > Every span in the resulting syntax tree will be set to resolve at the
macro call site.< / p >
2024-07-26 09:42:18 +00:00
< / div > < / details > < / div > < h2 id = "object-safety" class = "section-header" > Object Safety< a href = "#object-safety" class = "anchor" > §< / a > < / h2 > < div class = "object-safety-info" > This trait is < b > not< / b > < a href = "https://doc.rust-lang.org/1.80.0/reference/items/traits.html#object-safety" > object safe< / a > .< / div > < h2 id = "implementors" class = "section-header" > Implementors< a href = "#implementors" class = "anchor" > §< / a > < / h2 > < div id = "implementors-list" > < details class = "toggle implementors-toggle" > < summary > < section id = "impl-Parser-for-F" class = "impl" > < a class = "src rightside" href = "../../src/syn/parse.rs.html#1280-1311" > source< / a > < a href = "#impl-Parser-for-F" class = "anchor" > §< / a > < h3 class = "code-header" > impl< F, T> < a class = "trait" href = "trait.Parser.html" title = "trait syn::parse::Parser" > Parser< / a > for F< div class = "where" > where
F: < a class = "trait" href = "https://doc.rust-lang.org/1.80.0/core/ops/function/trait.FnOnce.html" title = "trait core::ops::function::FnOnce" > FnOnce< / a > (< a class = "type" href = "type.ParseStream.html" title = "type syn::parse::ParseStream" > ParseStream< / a > < '_> ) -> < a class = "type" href = "type.Result.html" title = "type syn::parse::Result" > Result< / a > < T> ,< / div > < / h3 > < / section > < / summary > < div class = "impl-items" > < section id = "associatedtype.Output-1" class = "associatedtype trait-impl" > < a href = "#associatedtype.Output-1" class = "anchor" > §< / a > < h4 class = "code-header" > type < a href = "#associatedtype.Output" class = "associatedtype" > Output< / a > = T< / h4 > < / section > < / div > < / details > < / div > < script src = "../../trait.impl/syn/parse/trait.Parser.js" async > < / script > < / section > < / div > < / main > < / body > < / html >
