2024-07-26 09:44:36 +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 = "Matches one token" > < title > any in winnow::token - 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 = "winnow" 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 fn" > <!-- [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 = "../../winnow/index.html" > winnow< / a > < span class = "version" > 0.6.16< / span > < / h2 > < / div > < div class = "sidebar-elems" > < h2 > < a href = "index.html" > In winnow::token< / 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 > Function < a href = "../index.html" > winnow< / a > ::< wbr > < a href = "index.html" > token< / a > ::< wbr > < a class = "fn" href = "#" > any< / 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/winnow/token/mod.rs.html#58-71" > source< / a > · < button id = "toggle-all-docs" title = "collapse all docs" > [< span > − < / span > ]< / button > < / span > < / div > < pre class = "rust item-decl" > < code > pub fn any< Input, Error> (
2024-07-26 09:42:18 +00:00
input: < a class = "primitive" href = "https://doc.rust-lang.org/1.80.0/std/primitive.reference.html" > & mut Input< / a > ,
2024-03-11 08:39:13 +00:00
) -> < a class = "type" href = "../error/type.PResult.html" title = "type winnow::error::PResult" > PResult< / a > < < Input as < a class = "trait" href = "../stream/trait.Stream.html" title = "trait winnow::stream::Stream" > Stream< / a > > ::< a class = "associatedtype" href = "../stream/trait.Stream.html#associatedtype.Token" title = "type winnow::stream::Stream::Token" > Token< / a > , Error> < div class = "where" > where
Input: < a class = "trait" href = "../stream/trait.StreamIsPartial.html" title = "trait winnow::stream::StreamIsPartial" > StreamIsPartial< / a > + < a class = "trait" href = "../stream/trait.Stream.html" title = "trait winnow::stream::Stream" > Stream< / a > ,
Error: < a class = "trait" href = "../error/trait.ParserError.html" title = "trait winnow::error::ParserError" > ParserError< / a > < Input> ,< / div > < / code > < / pre > < details class = "toggle top-doc" open > < summary class = "hideme" > < span > Expand description< / span > < / summary > < div class = "docblock" > < p > Matches one token< / p >
< p > < em > Complete version< / em > : Will return an error if there’ < / p >
< p > < em > [Partial version][crate::_topic::partial]< / em > : Will return < code > Err(winnow::error::ErrMode::Incomplete(_))< / code > if there’ < / p >
2024-03-27 11:12:16 +00:00
< h2 id = "effective-signature" > < a class = "doc-anchor" href = "#effective-signature" > §< / a > Effective Signature< / h2 >
2024-03-11 08:39:13 +00:00
< p > Assuming you are parsing a < code > & str< / code > < a href = "../stream/trait.Stream.html" title = "trait winnow::stream::Stream" > Stream< / a > :< / p >
< div class = "example-wrap" > < pre class = "rust rust-example-rendered" > < code > < span class = "kw" > pub fn < / span > any(input: < span class = "kw-2" > & mut & < / span > str) -> PResult< char> < / code > < / pre > < / div >
2024-03-27 11:12:16 +00:00
< h2 id = "example" > < a class = "doc-anchor" href = "#example" > §< / a > Example< / h2 >
2024-03-11 08:39:13 +00:00
< div class = "example-wrap" > < pre class = "rust rust-example-rendered" > < code > < span class = "kw" > fn < / span > parser(input: < span class = "kw-2" > & < / span > str) -> IResult< < span class = "kw-2" > & < / span > str, char> {
any.parse_peek(input)
}
< span class = "macro" > assert_eq!< / span > (parser(< span class = "string" > "abc"< / span > ), < span class = "prelude-val" > Ok< / span > ((< span class = "string" > "bc"< / span > ,< span class = "string" > 'a'< / span > )));
< span class = "macro" > assert_eq!< / span > (parser(< span class = "string" > ""< / span > ), < span class = "prelude-val" > Err< / span > (ErrMode::Backtrack(InputError::new(< span class = "string" > ""< / span > , ErrorKind::Token))));< / code > < / pre > < / div >
< div class = "example-wrap" > < pre class = "rust rust-example-rendered" > < code > < span class = "macro" > assert_eq!< / span > (any::< < span class = "kw" > _< / span > , InputError< < span class = "kw" > _< / span > > > .parse_peek(Partial::new(< span class = "string" > "abc"< / span > )), < span class = "prelude-val" > Ok< / span > ((Partial::new(< span class = "string" > "bc"< / span > ),< span class = "string" > 'a'< / span > )));
< span class = "macro" > assert_eq!< / span > (any::< < span class = "kw" > _< / span > , InputError< < span class = "kw" > _< / span > > > .parse_peek(Partial::new(< span class = "string" > ""< / span > )), < span class = "prelude-val" > Err< / span > (ErrMode::Incomplete(Needed::new(< span class = "number" > 1< / span > ))));< / code > < / pre > < / div >
< / div > < / details > < / section > < / div > < / main > < / body > < / html >
