|
|
<!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="General purpose combinators"><title>nom::combinator - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-ac92e1bbe349e143.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="nom" data-themes="" data-resource-suffix="" data-rustdoc-version="1.76.0 (07dca489a 2024-02-04)" data-channel="1.76.0" data-search-js="search-2b6ce74ff89ae146.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../static.files/storage-f2adc0d6ca4d09fb.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-305769736d49e732.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-feafe1bb7466e4bd.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-16x16-8b506e7a72182f1c.png"><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 mod"><!--[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></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../nom/index.html">nom</a><span class="version">7.1.3</span></h2></div><h2 class="location"><a href="#">Module combinator</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#structs">Structs</a></li><li><a href="#functions">Functions</a></li></ul></section><h2><a href="../index.html">In crate nom</a></h2></div></nav><div class="sidebar-resizer"></div>
|
|
|
<main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../../nom/all.html" title="show sidebar"></a></div><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" tabindex="-1"><a href="../../help.html" title="help">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Module <a href="../index.html">nom</a>::<wbr><a class="mod" href="#">combinator</a><button id="copy-path" title="Copy item path to clipboard"><img src="../../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../../src/nom/combinator/mod.rs.html#1-809">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>General purpose combinators</p>
|
|
|
</div></details><h2 id="structs" class="section-header"><a href="#structs">Structs</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.ParserIterator.html" title="struct nom::combinator::ParserIterator">ParserIterator</a></div><div class="desc docblock-short">Main structure associated to the <a href="fn.iterator.html" title="fn nom::combinator::iterator">iterator</a> function.</div></li></ul><h2 id="functions" class="section-header"><a href="#functions">Functions</a></h2><ul class="item-table"><li><div class="item-name"><a class="fn" href="fn.all_consuming.html" title="fn nom::combinator::all_consuming">all_consuming</a></div><div class="desc docblock-short">Succeeds if all the input has been consumed by its child parser.</div></li><li><div class="item-name"><a class="fn" href="fn.complete.html" title="fn nom::combinator::complete">complete</a></div><div class="desc docblock-short">Transforms Incomplete into <code>Error</code>.</div></li><li><div class="item-name"><a class="fn" href="fn.cond.html" title="fn nom::combinator::cond">cond</a></div><div class="desc docblock-short">Calls the parser if the condition is met.</div></li><li><div class="item-name"><a class="fn" href="fn.consumed.html" title="fn nom::combinator::consumed">consumed</a></div><div class="desc docblock-short">if the child parser was successful, return the consumed input with the output
|
|
|
as a tuple. Functions similarly to <a href="fn.recognize.html">recognize</a> except it
|
|
|
returns the parser output as well.</div></li><li><div class="item-name"><a class="fn" href="fn.cut.html" title="fn nom::combinator::cut">cut</a></div><div class="desc docblock-short">Transforms an <a href="../enum.Err.html#variant.Error" title="variant nom::Err::Error"><code>Err::Error</code></a> (recoverable) to <a href="../enum.Err.html#variant.Failure" title="variant nom::Err::Failure"><code>Err::Failure</code></a> (unrecoverable)</div></li><li><div class="item-name"><a class="fn" href="fn.eof.html" title="fn nom::combinator::eof">eof</a></div><div class="desc docblock-short">returns its input if it is at the end of input data</div></li><li><div class="item-name"><a class="fn" href="fn.fail.html" title="fn nom::combinator::fail">fail</a></div><div class="desc docblock-short">A parser which always fails.</div></li><li><div class="item-name"><a class="fn" href="fn.flat_map.html" title="fn nom::combinator::flat_map">flat_map</a></div><div class="desc docblock-short">Creates a new parser from the output of the first parser, then apply that parser over the rest of the input.</div></li><li><div class="item-name"><a class="fn" href="fn.into.html" title="fn nom::combinator::into">into</a></div><div class="desc docblock-short">automatically converts the child parser’s result to another type</div></li><li><div class="item-name"><a class="fn" href="fn.iterator.html" title="fn nom::combinator::iterator">iterator</a></div><div class="desc docblock-short">Creates an iterator from input data and a parser.</div></li><li><div class="item-name"><a class="fn" href="fn.map.html" title="fn nom::combinator::map">map</a></div><div class="desc docblock-short">Maps a function on the result of a parser.</div></li><li><div class="item-name"><a class="fn" href="fn.map_opt.html" title="fn nom::combinator::map_opt">map_opt</a></div><div class="desc docblock-short">Applies a function returning an <code>Option</code> over the result of a parser.</div></li><li><div class="item-name"><a class="fn" href="fn.map_parser.html" title="fn nom::combinator::map_parser">map_parser</a></div><div class="desc docblock-short">Applies a parser over the result of another one.</div></li><li><div class="item-name"><a class="fn" href="fn.map_res.html" title="fn nom::combinator::map_res">map_res</a></div><div class="desc docblock-short">Applies a function returning a <code>Result</code> over the result of a parser.</div></li><li><div class="item-name"><a class="fn" href="fn.not.html" title="fn nom::combinator::not">not</a></div><div class="desc docblock-short">Succeeds if the child parser returns an error.</div></li><li><div class="item-name"><a class="fn" href="fn.opt.html" title="fn nom::combinator::opt">opt</a></div><div class="desc docblock-short">Optional parser, will return <code>None</code> on <a href="../enum.Err.html#variant.Error" title="variant nom::Err::Error"><code>Err::Error</code></a>.</div></li><li><div class="item-name"><a class="fn" href="fn.peek.html" title="fn nom::combinator::peek">peek</a></div><div class="desc docblock-short">Tries to apply its parser without consuming the input.</div></li><li><div class="item-name"><a class="fn" href="fn.recognize.html" title="fn nom::combinator::recognize">recognize</a></div><div class="desc docblock-short">If the child parser was successful, return the consumed input as produced value.</div></li><li><div class="item-name"><a class="fn" href="fn.rest.html" title="fn nom::combinator::rest">rest</a></div><div class="desc docblock-short">Return the remaining input.</div></li><li><div class="item-name"><a class="fn" href="fn.rest_len.html" title="fn nom::combinator::rest_len">rest_len</a></div><div class="desc docblock-short">Return the length of the remaining input.</div></li><li><div class="item-name"><a class="fn" href="fn.success.html" title="fn nom::combinator::success">success</a></div><div class="desc docblock-short">a parser which always succeeds with given value without consuming any input.</div></li><li><div class="item-name"><a class="fn" href="fn.value.html" title="fn nom::combinator::value">value</a></div><div class="desc docblock-short">Returns the provided value if the child parser succeeds.</div></li><li><div class="item-name"><a class="fn" href="fn.verify.html" title="fn nom::combinator::verify">verify</a></div><div class="desc docblock-short">Returns the result of the child parser if it satisfies a verification function.</div></li></ul></section></div></main></body></html> |