349 lines
50 KiB
HTML
349 lines
50 KiB
HTML
<!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="nom, eating data byte by byte"><meta name="keywords" content="rust, rustlang, rust-lang, nom"><title>nom - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" type="text/css" href="../normalize.css"><link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../dark.css" disabled><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../storage.js"></script><script defer src="../crates.js"></script><script defer src="../main.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../favicon.svg"></head><body class="rustdoc mod crate"><!--[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">☰</button><a class="sidebar-logo" href="../nom/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../nom/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">Crate nom</a></h2><div class="sidebar-elems"><div class="block"><ul><li class="version">Version 7.1.2</li><li><a id="all-types" href="all.html">All Items</a></li></ul></div><section><div class="block"><ul><li><a href="#modules">Modules</a></li><li><a href="#macros">Macros</a></li><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#traits">Traits</a></li><li><a href="#types">Type Definitions</a></li></ul></div></section></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../nom/index.html"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Crate <a class="mod" href="#">nom</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../src/nom/lib.rs.html#1-464">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><h2 id="nom-eating-data-byte-by-byte"><a href="#nom-eating-data-byte-by-byte">nom, eating data byte by byte</a></h2>
|
||
<p>nom is a parser combinator library with a focus on safe parsing,
|
||
streaming patterns, and as much as possible zero copy.</p>
|
||
<h3 id="example"><a href="#example">Example</a></h3>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">nom</span>::{
|
||
<span class="ident">IResult</span>,
|
||
<span class="ident">bytes::complete</span>::{<span class="ident">tag</span>, <span class="ident">take_while_m_n</span>},
|
||
<span class="ident">combinator::map_res</span>,
|
||
<span class="ident">sequence::tuple</span>};
|
||
|
||
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>,<span class="ident">PartialEq</span>)]</span>
|
||
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">Color</span> {
|
||
<span class="kw">pub</span> <span class="ident">red</span>: <span class="ident">u8</span>,
|
||
<span class="kw">pub</span> <span class="ident">green</span>: <span class="ident">u8</span>,
|
||
<span class="kw">pub</span> <span class="ident">blue</span>: <span class="ident">u8</span>,
|
||
}
|
||
|
||
<span class="kw">fn</span> <span class="ident">from_hex</span>(<span class="ident">input</span>: <span class="kw-2">&</span><span class="ident">str</span>) -> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">u8</span>, <span class="ident">std::num::ParseIntError</span><span class="op">></span> {
|
||
<span class="ident">u8::from_str_radix</span>(<span class="ident">input</span>, <span class="number">16</span>)
|
||
}
|
||
|
||
<span class="kw">fn</span> <span class="ident">is_hex_digit</span>(<span class="ident">c</span>: <span class="ident">char</span>) -> <span class="ident">bool</span> {
|
||
<span class="ident">c</span>.<span class="ident">is_digit</span>(<span class="number">16</span>)
|
||
}
|
||
|
||
<span class="kw">fn</span> <span class="ident">hex_primary</span>(<span class="ident">input</span>: <span class="kw-2">&</span><span class="ident">str</span>) -> <span class="ident">IResult</span><span class="op"><</span><span class="kw-2">&</span><span class="ident">str</span>, <span class="ident">u8</span><span class="op">></span> {
|
||
<span class="ident">map_res</span>(
|
||
<span class="ident">take_while_m_n</span>(<span class="number">2</span>, <span class="number">2</span>, <span class="ident">is_hex_digit</span>),
|
||
<span class="ident">from_hex</span>
|
||
)(<span class="ident">input</span>)
|
||
}
|
||
|
||
<span class="kw">fn</span> <span class="ident">hex_color</span>(<span class="ident">input</span>: <span class="kw-2">&</span><span class="ident">str</span>) -> <span class="ident">IResult</span><span class="op"><</span><span class="kw-2">&</span><span class="ident">str</span>, <span class="ident">Color</span><span class="op">></span> {
|
||
<span class="kw">let</span> (<span class="ident">input</span>, <span class="kw">_</span>) <span class="op">=</span> <span class="ident">tag</span>(<span class="string">"#"</span>)(<span class="ident">input</span>)<span class="question-mark">?</span>;
|
||
<span class="kw">let</span> (<span class="ident">input</span>, (<span class="ident">red</span>, <span class="ident">green</span>, <span class="ident">blue</span>)) <span class="op">=</span> <span class="ident">tuple</span>((<span class="ident">hex_primary</span>, <span class="ident">hex_primary</span>, <span class="ident">hex_primary</span>))(<span class="ident">input</span>)<span class="question-mark">?</span>;
|
||
|
||
<span class="prelude-val">Ok</span>((<span class="ident">input</span>, <span class="ident">Color</span> { <span class="ident">red</span>, <span class="ident">green</span>, <span class="ident">blue</span> }))
|
||
}
|
||
|
||
<span class="kw">fn</span> <span class="ident">main</span>() {
|
||
<span class="macro">assert_eq!</span>(<span class="ident">hex_color</span>(<span class="string">"#2F14DF"</span>), <span class="prelude-val">Ok</span>((<span class="string">""</span>, <span class="ident">Color</span> {
|
||
<span class="ident">red</span>: <span class="number">47</span>,
|
||
<span class="ident">green</span>: <span class="number">20</span>,
|
||
<span class="ident">blue</span>: <span class="number">223</span>,
|
||
})));
|
||
}</code></pre></div>
|
||
<p>The code is available on <a href="https://github.com/Geal/nom">Github</a></p>
|
||
<p>There are a few <a href="https://github.com/Geal/nom/tree/main/doc">guides</a> with more details
|
||
about <a href="https://github.com/Geal/nom/blob/main/doc/making_a_new_parser_from_scratch.md">how to write parsers</a>,
|
||
or the <a href="https://github.com/Geal/nom/blob/main/doc/error_management.md">error management system</a>.
|
||
You can also check out the [recipes] module that contains examples of common patterns.</p>
|
||
<p><strong>Looking for a specific combinator? Read the
|
||
<a href="https://github.com/Geal/nom/blob/main/doc/choosing_a_combinator.md">“choose a combinator” guide</a></strong></p>
|
||
<p>If you are upgrading to nom 5.0, please read the
|
||
<a href="https://github.com/Geal/nom/blob/main/doc/upgrading_to_nom_5.md">migration document</a>.</p>
|
||
<h3 id="parser-combinators"><a href="#parser-combinators">Parser combinators</a></h3>
|
||
<p>Parser combinators are an approach to parsers that is very different from
|
||
software like <a href="https://en.wikipedia.org/wiki/Lex_(software)">lex</a> and
|
||
<a href="https://en.wikipedia.org/wiki/Yacc">yacc</a>. Instead of writing the grammar
|
||
in a separate syntax and generating the corresponding code, you use very small
|
||
functions with very specific purposes, like “take 5 bytes”, or “recognize the
|
||
word ‘HTTP’”, and assemble them in meaningful patterns like “recognize
|
||
‘HTTP’, then a space, then a version”.
|
||
The resulting code is small, and looks like the grammar you would have
|
||
written with other parser approaches.</p>
|
||
<p>This gives us a few advantages:</p>
|
||
<ul>
|
||
<li>The parsers are small and easy to write</li>
|
||
<li>The parsers components are easy to reuse (if they’re general enough, please add them to nom!)</li>
|
||
<li>The parsers components are easy to test separately (unit tests and property-based tests)</li>
|
||
<li>The parser combination code looks close to the grammar you would have written</li>
|
||
<li>You can build partial parsers, specific to the data you need at the moment, and ignore the rest</li>
|
||
</ul>
|
||
<p>Here is an example of one such parser, to recognize text between parentheses:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">nom</span>::{
|
||
<span class="ident">IResult</span>,
|
||
<span class="ident">sequence::delimited</span>,
|
||
<span class="comment">// see the "streaming/complete" paragraph lower for an explanation of these submodules</span>
|
||
<span class="ident">character::complete::char</span>,
|
||
<span class="ident">bytes::complete::is_not</span>
|
||
};
|
||
|
||
<span class="kw">fn</span> <span class="ident">parens</span>(<span class="ident">input</span>: <span class="kw-2">&</span><span class="ident">str</span>) -> <span class="ident">IResult</span><span class="op"><</span><span class="kw-2">&</span><span class="ident">str</span>, <span class="kw-2">&</span><span class="ident">str</span><span class="op">></span> {
|
||
<span class="ident">delimited</span>(<span class="ident">char</span>(<span class="string">'('</span>), <span class="ident">is_not</span>(<span class="string">")"</span>), <span class="ident">char</span>(<span class="string">')'</span>))(<span class="ident">input</span>)
|
||
}</code></pre></div>
|
||
<p>It defines a function named <code>parens</code> which will recognize a sequence of the
|
||
character <code>(</code>, the longest byte array not containing <code>)</code>, then the character
|
||
<code>)</code>, and will return the byte array in the middle.</p>
|
||
<p>Here is another parser, written without using nom’s combinators this time:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">nom</span>::{<span class="ident">IResult</span>, <span class="prelude-val">Err</span>, <span class="ident">Needed</span>};
|
||
|
||
<span class="kw">fn</span> <span class="ident">take4</span>(<span class="ident">i</span>: <span class="kw-2">&</span>[<span class="ident">u8</span>]) -> <span class="ident">IResult</span><span class="op"><</span><span class="kw-2">&</span>[<span class="ident">u8</span>], <span class="kw-2">&</span>[<span class="ident">u8</span>]<span class="op">></span>{
|
||
<span class="kw">if</span> <span class="ident">i</span>.<span class="ident">len</span>() <span class="op"><</span> <span class="number">4</span> {
|
||
<span class="prelude-val">Err</span>(<span class="ident">Err::Incomplete</span>(<span class="ident">Needed::new</span>(<span class="number">4</span>)))
|
||
} <span class="kw">else</span> {
|
||
<span class="prelude-val">Ok</span>((<span class="kw-2">&</span><span class="ident">i</span>[<span class="number">4</span>..], <span class="kw-2">&</span><span class="ident">i</span>[<span class="number">0</span>..<span class="number">4</span>]))
|
||
}
|
||
}</code></pre></div>
|
||
<p>This function takes a byte array as input, and tries to consume 4 bytes.
|
||
Writing all the parsers manually, like this, is dangerous, despite Rust’s
|
||
safety features. There are still a lot of mistakes one can make. That’s why
|
||
nom provides a list of functions to help in developing parsers.</p>
|
||
<p>With functions, you would write it like this:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">nom</span>::{<span class="ident">IResult</span>, <span class="ident">bytes::streaming::take</span>};
|
||
<span class="kw">fn</span> <span class="ident">take4</span>(<span class="ident">input</span>: <span class="kw-2">&</span><span class="ident">str</span>) -> <span class="ident">IResult</span><span class="op"><</span><span class="kw-2">&</span><span class="ident">str</span>, <span class="kw-2">&</span><span class="ident">str</span><span class="op">></span> {
|
||
<span class="ident">take</span>(<span class="number">4u8</span>)(<span class="ident">input</span>)
|
||
}</code></pre></div>
|
||
<p>A parser in nom is a function which, for an input type <code>I</code>, an output type <code>O</code>
|
||
and an optional error type <code>E</code>, will have the following signature:</p>
|
||
|
||
<div class='information'><div class='tooltip compile_fail'>ⓘ</div></div><div class="example-wrap"><pre class="rust rust-example-rendered compile_fail"><code><span class="kw">fn</span> <span class="ident">parser</span>(<span class="ident">input</span>: <span class="ident">I</span>) -> <span class="ident">IResult</span><span class="op"><</span><span class="ident">I</span>, <span class="ident">O</span>, <span class="ident">E</span><span class="op">></span>;</code></pre></div>
|
||
<p>Or like this, if you don’t want to specify a custom error type (it will be <code>(I, ErrorKind)</code> by default):</p>
|
||
|
||
<div class='information'><div class='tooltip compile_fail'>ⓘ</div></div><div class="example-wrap"><pre class="rust rust-example-rendered compile_fail"><code><span class="kw">fn</span> <span class="ident">parser</span>(<span class="ident">input</span>: <span class="ident">I</span>) -> <span class="ident">IResult</span><span class="op"><</span><span class="ident">I</span>, <span class="ident">O</span><span class="op">></span>;</code></pre></div>
|
||
<p><code>IResult</code> is an alias for the <code>Result</code> type:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">nom</span>::{<span class="ident">Needed</span>, <span class="ident">error::Error</span>};
|
||
|
||
<span class="kw">type</span> <span class="ident">IResult</span><span class="op"><</span><span class="ident">I</span>, <span class="ident">O</span>, <span class="ident">E</span> <span class="op">=</span> <span class="ident">Error</span><span class="op"><</span><span class="ident">I</span><span class="op">></span><span class="op">></span> <span class="op">=</span> <span class="prelude-ty">Result</span><span class="op"><</span>(<span class="ident">I</span>, <span class="ident">O</span>), <span class="prelude-val">Err</span><span class="op"><</span><span class="ident">E</span><span class="op">></span><span class="op">></span>;
|
||
|
||
<span class="kw">enum</span> <span class="prelude-val">Err</span><span class="op"><</span><span class="ident">E</span><span class="op">></span> {
|
||
<span class="ident">Incomplete</span>(<span class="ident">Needed</span>),
|
||
<span class="ident">Error</span>(<span class="ident">E</span>),
|
||
<span class="ident">Failure</span>(<span class="ident">E</span>),
|
||
}</code></pre></div>
|
||
<p>It can have the following values:</p>
|
||
<ul>
|
||
<li>A correct result <code>Ok((I,O))</code> with the first element being the remaining of the input (not parsed yet), and the second the output value;</li>
|
||
<li>An error <code>Err(Err::Error(c))</code> with <code>c</code> an error that can be built from the input position and a parser specific error</li>
|
||
<li>An error <code>Err(Err::Incomplete(Needed))</code> indicating that more input is necessary. <code>Needed</code> can indicate how much data is needed</li>
|
||
<li>An error <code>Err(Err::Failure(c))</code>. It works like the <code>Error</code> case, except it indicates an unrecoverable error: We cannot backtrack and test another parser</li>
|
||
</ul>
|
||
<p>Please refer to the <a href="https://github.com/Geal/nom/blob/main/doc/choosing_a_combinator.md">“choose a combinator” guide</a> for an exhaustive list of parsers.
|
||
See also the rest of the documentation <a href="https://github.com/Geal/nom/blob/main/doc">here</a>.</p>
|
||
<h3 id="making-new-parsers-with-function-combinators"><a href="#making-new-parsers-with-function-combinators">Making new parsers with function combinators</a></h3>
|
||
<p>nom is based on functions that generate parsers, with a signature like
|
||
this: <code>(arguments) -> impl Fn(Input) -> IResult<Input, Output, Error></code>.
|
||
The arguments of a combinator can be direct values (like <code>take</code> which uses
|
||
a number of bytes or character as argument) or even other parsers (like
|
||
<code>delimited</code> which takes as argument 3 parsers, and returns the result of
|
||
the second one if all are successful).</p>
|
||
<p>Here are some examples:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">nom::IResult</span>;
|
||
<span class="kw">use</span> <span class="ident">nom::bytes::complete</span>::{<span class="ident">tag</span>, <span class="ident">take</span>};
|
||
<span class="kw">fn</span> <span class="ident">abcd_parser</span>(<span class="ident">i</span>: <span class="kw-2">&</span><span class="ident">str</span>) -> <span class="ident">IResult</span><span class="op"><</span><span class="kw-2">&</span><span class="ident">str</span>, <span class="kw-2">&</span><span class="ident">str</span><span class="op">></span> {
|
||
<span class="ident">tag</span>(<span class="string">"abcd"</span>)(<span class="ident">i</span>) <span class="comment">// will consume bytes if the input begins with "abcd"</span>
|
||
}
|
||
|
||
<span class="kw">fn</span> <span class="ident">take_10</span>(<span class="ident">i</span>: <span class="kw-2">&</span>[<span class="ident">u8</span>]) -> <span class="ident">IResult</span><span class="op"><</span><span class="kw-2">&</span>[<span class="ident">u8</span>], <span class="kw-2">&</span>[<span class="ident">u8</span>]<span class="op">></span> {
|
||
<span class="ident">take</span>(<span class="number">10u8</span>)(<span class="ident">i</span>) <span class="comment">// will consume and return 10 bytes of input</span>
|
||
}</code></pre></div>
|
||
<h3 id="combining-parsers"><a href="#combining-parsers">Combining parsers</a></h3>
|
||
<p>There are higher level patterns, like the <strong><code>alt</code></strong> combinator, which
|
||
provides a choice between multiple parsers. If one branch fails, it tries
|
||
the next, and returns the result of the first parser that succeeds:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">nom::IResult</span>;
|
||
<span class="kw">use</span> <span class="ident">nom::branch::alt</span>;
|
||
<span class="kw">use</span> <span class="ident">nom::bytes::complete::tag</span>;
|
||
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">alt_tags</span> <span class="op">=</span> <span class="ident">alt</span>((<span class="ident">tag</span>(<span class="string">"abcd"</span>), <span class="ident">tag</span>(<span class="string">"efgh"</span>)));
|
||
|
||
<span class="macro">assert_eq!</span>(<span class="ident">alt_tags</span>(<span class="kw-2">&</span><span class="string">b"abcdxxx"</span>[..]), <span class="prelude-val">Ok</span>((<span class="kw-2">&</span><span class="string">b"xxx"</span>[..], <span class="kw-2">&</span><span class="string">b"abcd"</span>[..])));
|
||
<span class="macro">assert_eq!</span>(<span class="ident">alt_tags</span>(<span class="kw-2">&</span><span class="string">b"efghxxx"</span>[..]), <span class="prelude-val">Ok</span>((<span class="kw-2">&</span><span class="string">b"xxx"</span>[..], <span class="kw-2">&</span><span class="string">b"efgh"</span>[..])));
|
||
<span class="macro">assert_eq!</span>(<span class="ident">alt_tags</span>(<span class="kw-2">&</span><span class="string">b"ijklxxx"</span>[..]), <span class="prelude-val">Err</span>(<span class="ident">nom::Err::Error</span>((<span class="kw-2">&</span><span class="string">b"ijklxxx"</span>[..], <span class="ident">nom::error::ErrorKind::Tag</span>))));</code></pre></div>
|
||
<p>The <strong><code>opt</code></strong> combinator makes a parser optional. If the child parser returns
|
||
an error, <strong><code>opt</code></strong> will still succeed and return None:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">nom</span>::{<span class="ident">IResult</span>, <span class="ident">combinator::opt</span>, <span class="ident">bytes::complete::tag</span>};
|
||
<span class="kw">fn</span> <span class="ident">abcd_opt</span>(<span class="ident">i</span>: <span class="kw-2">&</span>[<span class="ident">u8</span>]) -> <span class="ident">IResult</span><span class="op"><</span><span class="kw-2">&</span>[<span class="ident">u8</span>], <span class="prelude-ty">Option</span><span class="op"><</span><span class="kw-2">&</span>[<span class="ident">u8</span>]<span class="op">></span><span class="op">></span> {
|
||
<span class="ident">opt</span>(<span class="ident">tag</span>(<span class="string">"abcd"</span>))(<span class="ident">i</span>)
|
||
}
|
||
|
||
<span class="macro">assert_eq!</span>(<span class="ident">abcd_opt</span>(<span class="kw-2">&</span><span class="string">b"abcdxxx"</span>[..]), <span class="prelude-val">Ok</span>((<span class="kw-2">&</span><span class="string">b"xxx"</span>[..], <span class="prelude-val">Some</span>(<span class="kw-2">&</span><span class="string">b"abcd"</span>[..]))));
|
||
<span class="macro">assert_eq!</span>(<span class="ident">abcd_opt</span>(<span class="kw-2">&</span><span class="string">b"efghxxx"</span>[..]), <span class="prelude-val">Ok</span>((<span class="kw-2">&</span><span class="string">b"efghxxx"</span>[..], <span class="prelude-val">None</span>)));</code></pre></div>
|
||
<p><strong><code>many0</code></strong> applies a parser 0 or more times, and returns a vector of the aggregated results:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">nom</span>::{<span class="ident">IResult</span>, <span class="ident">multi::many0</span>, <span class="ident">bytes::complete::tag</span>};
|
||
<span class="kw">use</span> <span class="ident">std::str</span>;
|
||
|
||
<span class="kw">fn</span> <span class="ident">multi</span>(<span class="ident">i</span>: <span class="kw-2">&</span><span class="ident">str</span>) -> <span class="ident">IResult</span><span class="op"><</span><span class="kw-2">&</span><span class="ident">str</span>, <span class="ident">Vec</span><span class="op"><</span><span class="kw-2">&</span><span class="ident">str</span><span class="op">></span><span class="op">></span> {
|
||
<span class="ident">many0</span>(<span class="ident">tag</span>(<span class="string">"abcd"</span>))(<span class="ident">i</span>)
|
||
}
|
||
|
||
<span class="kw">let</span> <span class="ident">a</span> <span class="op">=</span> <span class="string">"abcdef"</span>;
|
||
<span class="kw">let</span> <span class="ident">b</span> <span class="op">=</span> <span class="string">"abcdabcdef"</span>;
|
||
<span class="kw">let</span> <span class="ident">c</span> <span class="op">=</span> <span class="string">"azerty"</span>;
|
||
<span class="macro">assert_eq!</span>(<span class="ident">multi</span>(<span class="ident">a</span>), <span class="prelude-val">Ok</span>((<span class="string">"ef"</span>, <span class="macro">vec!</span>[<span class="string">"abcd"</span>])));
|
||
<span class="macro">assert_eq!</span>(<span class="ident">multi</span>(<span class="ident">b</span>), <span class="prelude-val">Ok</span>((<span class="string">"ef"</span>, <span class="macro">vec!</span>[<span class="string">"abcd"</span>, <span class="string">"abcd"</span>])));
|
||
<span class="macro">assert_eq!</span>(<span class="ident">multi</span>(<span class="ident">c</span>), <span class="prelude-val">Ok</span>((<span class="string">"azerty"</span>, <span class="ident">Vec::new</span>())));</code></pre></div>
|
||
<p>Here are some basic combinators available:</p>
|
||
<ul>
|
||
<li><strong><code>opt</code></strong>: Will make the parser optional (if it returns the <code>O</code> type, the new parser returns <code>Option<O></code>)</li>
|
||
<li><strong><code>many0</code></strong>: Will apply the parser 0 or more times (if it returns the <code>O</code> type, the new parser returns <code>Vec<O></code>)</li>
|
||
<li><strong><code>many1</code></strong>: Will apply the parser 1 or more times</li>
|
||
</ul>
|
||
<p>There are more complex (and more useful) parsers like <code>tuple</code>, which is
|
||
used to apply a series of parsers then assemble their results.</p>
|
||
<p>Example with <code>tuple</code>:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">nom</span>::{<span class="ident">error::ErrorKind</span>, <span class="ident">Needed</span>,
|
||
<span class="ident">number::streaming::be_u16</span>,
|
||
<span class="ident">bytes::streaming</span>::{<span class="ident">tag</span>, <span class="ident">take</span>},
|
||
<span class="ident">sequence::tuple</span>};
|
||
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">tpl</span> <span class="op">=</span> <span class="ident">tuple</span>((<span class="ident">be_u16</span>, <span class="ident">take</span>(<span class="number">3u8</span>), <span class="ident">tag</span>(<span class="string">"fg"</span>)));
|
||
|
||
<span class="macro">assert_eq!</span>(
|
||
<span class="ident">tpl</span>(<span class="kw-2">&</span><span class="string">b"abcdefgh"</span>[..]),
|
||
<span class="prelude-val">Ok</span>((
|
||
<span class="kw-2">&</span><span class="string">b"h"</span>[..],
|
||
(<span class="number">0x6162u16</span>, <span class="kw-2">&</span><span class="string">b"cde"</span>[..], <span class="kw-2">&</span><span class="string">b"fg"</span>[..])
|
||
))
|
||
);
|
||
<span class="macro">assert_eq!</span>(<span class="ident">tpl</span>(<span class="kw-2">&</span><span class="string">b"abcde"</span>[..]), <span class="prelude-val">Err</span>(<span class="ident">nom::Err::Incomplete</span>(<span class="ident">Needed::new</span>(<span class="number">2</span>))));
|
||
<span class="kw">let</span> <span class="ident">input</span> <span class="op">=</span> <span class="kw-2">&</span><span class="string">b"abcdejk"</span>[..];
|
||
<span class="macro">assert_eq!</span>(<span class="ident">tpl</span>(<span class="ident">input</span>), <span class="prelude-val">Err</span>(<span class="ident">nom::Err::Error</span>((<span class="kw-2">&</span><span class="ident">input</span>[<span class="number">5</span>..], <span class="ident">ErrorKind::Tag</span>))));</code></pre></div>
|
||
<p>But you can also use a sequence of combinators written in imperative style,
|
||
thanks to the <code>?</code> operator:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">nom</span>::{<span class="ident">IResult</span>, <span class="ident">bytes::complete::tag</span>};
|
||
|
||
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>, <span class="ident">PartialEq</span>)]</span>
|
||
<span class="kw">struct</span> <span class="ident">A</span> {
|
||
<span class="ident">a</span>: <span class="ident">u8</span>,
|
||
<span class="ident">b</span>: <span class="ident">u8</span>
|
||
}
|
||
|
||
<span class="kw">fn</span> <span class="ident">ret_int1</span>(<span class="ident">i</span>:<span class="kw-2">&</span>[<span class="ident">u8</span>]) -> <span class="ident">IResult</span><span class="op"><</span><span class="kw-2">&</span>[<span class="ident">u8</span>], <span class="ident">u8</span><span class="op">></span> { <span class="prelude-val">Ok</span>((<span class="ident">i</span>,<span class="number">1</span>)) }
|
||
<span class="kw">fn</span> <span class="ident">ret_int2</span>(<span class="ident">i</span>:<span class="kw-2">&</span>[<span class="ident">u8</span>]) -> <span class="ident">IResult</span><span class="op"><</span><span class="kw-2">&</span>[<span class="ident">u8</span>], <span class="ident">u8</span><span class="op">></span> { <span class="prelude-val">Ok</span>((<span class="ident">i</span>,<span class="number">2</span>)) }
|
||
|
||
<span class="kw">fn</span> <span class="ident">f</span>(<span class="ident">i</span>: <span class="kw-2">&</span>[<span class="ident">u8</span>]) -> <span class="ident">IResult</span><span class="op"><</span><span class="kw-2">&</span>[<span class="ident">u8</span>], <span class="ident">A</span><span class="op">></span> {
|
||
<span class="comment">// if successful, the parser returns `Ok((remaining_input, output_value))` that we can destructure</span>
|
||
<span class="kw">let</span> (<span class="ident">i</span>, <span class="kw">_</span>) <span class="op">=</span> <span class="ident">tag</span>(<span class="string">"abcd"</span>)(<span class="ident">i</span>)<span class="question-mark">?</span>;
|
||
<span class="kw">let</span> (<span class="ident">i</span>, <span class="ident">a</span>) <span class="op">=</span> <span class="ident">ret_int1</span>(<span class="ident">i</span>)<span class="question-mark">?</span>;
|
||
<span class="kw">let</span> (<span class="ident">i</span>, <span class="kw">_</span>) <span class="op">=</span> <span class="ident">tag</span>(<span class="string">"efgh"</span>)(<span class="ident">i</span>)<span class="question-mark">?</span>;
|
||
<span class="kw">let</span> (<span class="ident">i</span>, <span class="ident">b</span>) <span class="op">=</span> <span class="ident">ret_int2</span>(<span class="ident">i</span>)<span class="question-mark">?</span>;
|
||
|
||
<span class="prelude-val">Ok</span>((<span class="ident">i</span>, <span class="ident">A</span> { <span class="ident">a</span>, <span class="ident">b</span> }))
|
||
}
|
||
|
||
<span class="kw">let</span> <span class="ident">r</span> <span class="op">=</span> <span class="ident">f</span>(<span class="string">b"abcdefghX"</span>);
|
||
<span class="macro">assert_eq!</span>(<span class="ident">r</span>, <span class="prelude-val">Ok</span>((<span class="kw-2">&</span><span class="string">b"X"</span>[..], <span class="ident">A</span>{<span class="ident">a</span>: <span class="number">1</span>, <span class="ident">b</span>: <span class="number">2</span>})));</code></pre></div>
|
||
<h3 id="streaming--complete"><a href="#streaming--complete">Streaming / Complete</a></h3>
|
||
<p>Some of nom’s modules have <code>streaming</code> or <code>complete</code> submodules. They hold
|
||
different variants of the same combinators.</p>
|
||
<p>A streaming parser assumes that we might not have all of the input data.
|
||
This can happen with some network protocol or large file parsers, where the
|
||
input buffer can be full and need to be resized or refilled.</p>
|
||
<p>A complete parser assumes that we already have all of the input data.
|
||
This will be the common case with small files that can be read entirely to
|
||
memory.</p>
|
||
<p>Here is how it works in practice:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">nom</span>::{<span class="ident">IResult</span>, <span class="prelude-val">Err</span>, <span class="ident">Needed</span>, <span class="ident">error</span>::{<span class="ident">Error</span>, <span class="ident">ErrorKind</span>}, <span class="ident">bytes</span>, <span class="ident">character</span>};
|
||
|
||
<span class="kw">fn</span> <span class="ident">take_streaming</span>(<span class="ident">i</span>: <span class="kw-2">&</span>[<span class="ident">u8</span>]) -> <span class="ident">IResult</span><span class="op"><</span><span class="kw-2">&</span>[<span class="ident">u8</span>], <span class="kw-2">&</span>[<span class="ident">u8</span>]<span class="op">></span> {
|
||
<span class="ident">bytes::streaming::take</span>(<span class="number">4u8</span>)(<span class="ident">i</span>)
|
||
}
|
||
|
||
<span class="kw">fn</span> <span class="ident">take_complete</span>(<span class="ident">i</span>: <span class="kw-2">&</span>[<span class="ident">u8</span>]) -> <span class="ident">IResult</span><span class="op"><</span><span class="kw-2">&</span>[<span class="ident">u8</span>], <span class="kw-2">&</span>[<span class="ident">u8</span>]<span class="op">></span> {
|
||
<span class="ident">bytes::complete::take</span>(<span class="number">4u8</span>)(<span class="ident">i</span>)
|
||
}
|
||
|
||
<span class="comment">// both parsers will take 4 bytes as expected</span>
|
||
<span class="macro">assert_eq!</span>(<span class="ident">take_streaming</span>(<span class="kw-2">&</span><span class="string">b"abcde"</span>[..]), <span class="prelude-val">Ok</span>((<span class="kw-2">&</span><span class="string">b"e"</span>[..], <span class="kw-2">&</span><span class="string">b"abcd"</span>[..])));
|
||
<span class="macro">assert_eq!</span>(<span class="ident">take_complete</span>(<span class="kw-2">&</span><span class="string">b"abcde"</span>[..]), <span class="prelude-val">Ok</span>((<span class="kw-2">&</span><span class="string">b"e"</span>[..], <span class="kw-2">&</span><span class="string">b"abcd"</span>[..])));
|
||
|
||
<span class="comment">// if the input is smaller than 4 bytes, the streaming parser</span>
|
||
<span class="comment">// will return `Incomplete` to indicate that we need more data</span>
|
||
<span class="macro">assert_eq!</span>(<span class="ident">take_streaming</span>(<span class="kw-2">&</span><span class="string">b"abc"</span>[..]), <span class="prelude-val">Err</span>(<span class="ident">Err::Incomplete</span>(<span class="ident">Needed::new</span>(<span class="number">1</span>))));
|
||
|
||
<span class="comment">// but the complete parser will return an error</span>
|
||
<span class="macro">assert_eq!</span>(<span class="ident">take_complete</span>(<span class="kw-2">&</span><span class="string">b"abc"</span>[..]), <span class="prelude-val">Err</span>(<span class="ident">Err::Error</span>(<span class="ident">Error::new</span>(<span class="kw-2">&</span><span class="string">b"abc"</span>[..], <span class="ident">ErrorKind::Eof</span>))));
|
||
|
||
<span class="comment">// the alpha0 function recognizes 0 or more alphabetic characters</span>
|
||
<span class="kw">fn</span> <span class="ident">alpha0_streaming</span>(<span class="ident">i</span>: <span class="kw-2">&</span><span class="ident">str</span>) -> <span class="ident">IResult</span><span class="op"><</span><span class="kw-2">&</span><span class="ident">str</span>, <span class="kw-2">&</span><span class="ident">str</span><span class="op">></span> {
|
||
<span class="ident">character::streaming::alpha0</span>(<span class="ident">i</span>)
|
||
}
|
||
|
||
<span class="kw">fn</span> <span class="ident">alpha0_complete</span>(<span class="ident">i</span>: <span class="kw-2">&</span><span class="ident">str</span>) -> <span class="ident">IResult</span><span class="op"><</span><span class="kw-2">&</span><span class="ident">str</span>, <span class="kw-2">&</span><span class="ident">str</span><span class="op">></span> {
|
||
<span class="ident">character::complete::alpha0</span>(<span class="ident">i</span>)
|
||
}
|
||
|
||
<span class="comment">// if there's a clear limit to the recognized characters, both parsers work the same way</span>
|
||
<span class="macro">assert_eq!</span>(<span class="ident">alpha0_streaming</span>(<span class="string">"abcd;"</span>), <span class="prelude-val">Ok</span>((<span class="string">";"</span>, <span class="string">"abcd"</span>)));
|
||
<span class="macro">assert_eq!</span>(<span class="ident">alpha0_complete</span>(<span class="string">"abcd;"</span>), <span class="prelude-val">Ok</span>((<span class="string">";"</span>, <span class="string">"abcd"</span>)));
|
||
|
||
<span class="comment">// but when there's no limit, the streaming version returns `Incomplete`, because it cannot</span>
|
||
<span class="comment">// know if more input data should be recognized. The whole input could be "abcd;", or</span>
|
||
<span class="comment">// "abcde;"</span>
|
||
<span class="macro">assert_eq!</span>(<span class="ident">alpha0_streaming</span>(<span class="string">"abcd"</span>), <span class="prelude-val">Err</span>(<span class="ident">Err::Incomplete</span>(<span class="ident">Needed::new</span>(<span class="number">1</span>))));
|
||
|
||
<span class="comment">// while the complete version knows that all of the data is there</span>
|
||
<span class="macro">assert_eq!</span>(<span class="ident">alpha0_complete</span>(<span class="string">"abcd"</span>), <span class="prelude-val">Ok</span>((<span class="string">""</span>, <span class="string">"abcd"</span>)));</code></pre></div>
|
||
<p><strong>Going further:</strong> Read the <a href="https://github.com/Geal/nom/tree/main/doc">guides</a>,
|
||
check out the [recipes]!</p>
|
||
</div></details><h2 id="reexports" class="small-section-header"><a href="#reexports">Re-exports</a></h2><div class="item-table"><div class="item-row"><div class="item-left import-item"><code>pub use self::<a class="mod" href="bits/index.html" title="mod nom::bits">bits</a>::*;</code></div><div class="item-right docblock-short"></div></div></div><h2 id="modules" class="small-section-header"><a href="#modules">Modules</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="mod" href="bits/index.html" title="nom::bits mod">bits</a></div><div class="item-right docblock-short"><p>Bit level parsers</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="branch/index.html" title="nom::branch mod">branch</a></div><div class="item-right docblock-short"><p>Choice combinators</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="bytes/index.html" title="nom::bytes mod">bytes</a></div><div class="item-right docblock-short"><p>Parsers recognizing bytes streams</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="character/index.html" title="nom::character mod">character</a></div><div class="item-right docblock-short"><p>Character specific parsers and combinators</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="combinator/index.html" title="nom::combinator mod">combinator</a></div><div class="item-right docblock-short"><p>General purpose combinators</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="error/index.html" title="nom::error mod">error</a></div><div class="item-right docblock-short"><p>Error management</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="lib/index.html" title="nom::lib mod">lib</a></div><div class="item-right docblock-short"><p>Lib module to re-export everything needed from <code>std</code> or <code>core</code>/<code>alloc</code>. This is how <code>serde</code> does
|
||
it, albeit there it is not public.</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="multi/index.html" title="nom::multi mod">multi</a></div><div class="item-right docblock-short"><p>Combinators applying their child parser multiple times</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="number/index.html" title="nom::number mod">number</a></div><div class="item-right docblock-short"><p>Parsers recognizing numbers</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="sequence/index.html" title="nom::sequence mod">sequence</a></div><div class="item-right docblock-short"><p>Combinators applying parsers in sequence</p>
|
||
</div></div></div><h2 id="macros" class="small-section-header"><a href="#macros">Macros</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="macro" href="macro.error_node_position.html" title="nom::error_node_position macro">error_node_position</a></div><div class="item-right docblock-short"><p>Creates a parse error from a <code>nom::ErrorKind</code>,
|
||
the position in the input and the next error in
|
||
the parsing tree</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="macro" href="macro.error_position.html" title="nom::error_position macro">error_position</a></div><div class="item-right docblock-short"><p>Creates a parse error from a <code>nom::ErrorKind</code>
|
||
and the position in the input</p>
|
||
</div></div></div><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.And.html" title="nom::And struct">And</a></div><div class="item-right docblock-short"><p>Implementation of <code>Parser::and</code></p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.AndThen.html" title="nom::AndThen struct">AndThen</a></div><div class="item-right docblock-short"><p>Implementation of <code>Parser::and_then</code></p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.FlatMap.html" title="nom::FlatMap struct">FlatMap</a></div><div class="item-right docblock-short"><p>Implementation of <code>Parser::flat_map</code></p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Into.html" title="nom::Into struct">Into</a></div><div class="item-right docblock-short"><p>Implementation of <code>Parser::into</code></p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Map.html" title="nom::Map struct">Map</a></div><div class="item-right docblock-short"><p>Implementation of <code>Parser::map</code></p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Or.html" title="nom::Or struct">Or</a></div><div class="item-right docblock-short"><p>Implementation of <code>Parser::or</code></p>
|
||
</div></div></div><h2 id="enums" class="small-section-header"><a href="#enums">Enums</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.CompareResult.html" title="nom::CompareResult enum">CompareResult</a></div><div class="item-right docblock-short"><p>Indicates whether a comparison was successful, an error, or
|
||
if more data was needed</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.Err.html" title="nom::Err enum">Err</a></div><div class="item-right docblock-short"><p>The <code>Err</code> enum indicates the parser was not successful</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.Needed.html" title="nom::Needed enum">Needed</a></div><div class="item-right docblock-short"><p>Contains information on needed data if a parser returned <code>Incomplete</code></p>
|
||
</div></div></div><h2 id="traits" class="small-section-header"><a href="#traits">Traits</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.AsBytes.html" title="nom::AsBytes trait">AsBytes</a></div><div class="item-right docblock-short"><p>Helper trait for types that can be viewed as a byte slice</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.AsChar.html" title="nom::AsChar trait">AsChar</a></div><div class="item-right docblock-short"><p>Transforms common types to a char for basic token parsing</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.Compare.html" title="nom::Compare trait">Compare</a></div><div class="item-right docblock-short"><p>Abstracts comparison operations</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.ErrorConvert.html" title="nom::ErrorConvert trait">ErrorConvert</a></div><div class="item-right docblock-short"><p>Equivalent From implementation to avoid orphan rules in bits parsers</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.ExtendInto.html" title="nom::ExtendInto trait">ExtendInto</a></div><div class="item-right docblock-short"><p>Abstracts something which can extend an <code>Extend</code>.
|
||
Used to build modified input slices in <code>escaped_transform</code></p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.FindSubstring.html" title="nom::FindSubstring trait">FindSubstring</a></div><div class="item-right docblock-short"><p>Look for a substring in self</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.FindToken.html" title="nom::FindToken trait">FindToken</a></div><div class="item-right docblock-short"><p>Look for a token in self</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.Finish.html" title="nom::Finish trait">Finish</a></div><div class="item-right docblock-short"><p>Helper trait to convert a parser’s result to a more manageable type</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.HexDisplay.html" title="nom::HexDisplay trait">HexDisplay</a></div><div class="item-right docblock-short"><p>Helper trait to show a byte slice as a hex dump</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.InputIter.html" title="nom::InputIter trait">InputIter</a></div><div class="item-right docblock-short"><p>Abstracts common iteration operations on the input type</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.InputLength.html" title="nom::InputLength trait">InputLength</a></div><div class="item-right docblock-short"><p>Abstract method to calculate the input length</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.InputTake.html" title="nom::InputTake trait">InputTake</a></div><div class="item-right docblock-short"><p>Abstracts slicing operations</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.InputTakeAtPosition.html" title="nom::InputTakeAtPosition trait">InputTakeAtPosition</a></div><div class="item-right docblock-short"><p>Methods to take as much input as possible until the provided function returns true for the current element.</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.Offset.html" title="nom::Offset trait">Offset</a></div><div class="item-right docblock-short"><p>Useful functions to calculate the offset between slices and show a hexdump of a slice</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.ParseTo.html" title="nom::ParseTo trait">ParseTo</a></div><div class="item-right docblock-short"><p>Used to integrate <code>str</code>’s <code>parse()</code> method</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.Parser.html" title="nom::Parser trait">Parser</a></div><div class="item-right docblock-short"><p>All nom parsers implement this trait</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.Slice.html" title="nom::Slice trait">Slice</a></div><div class="item-right docblock-short"><p>Slicing operations using ranges.</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.ToUsize.html" title="nom::ToUsize trait">ToUsize</a></div><div class="item-right docblock-short"><p>Helper trait to convert numbers to usize.</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.UnspecializedInput.html" title="nom::UnspecializedInput trait">UnspecializedInput</a></div><div class="item-right docblock-short"><p>Dummy trait used for default implementations (currently only used for <code>InputTakeAtPosition</code> and <code>Compare</code>).</p>
|
||
</div></div></div><h2 id="types" class="small-section-header"><a href="#types">Type Definitions</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="type" href="type.IResult.html" title="nom::IResult type">IResult</a></div><div class="item-right docblock-short"><p>Holds the result of parsing functions</p>
|
||
</div></div></div></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="nom" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html> |