blob: 38b9f41821be2481ec7b8e9e43ed38529681275d [file] [log] [blame]
<!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="Module containing zero-copy parsers."><meta name="keywords" content="rust, rustlang, rust-lang, range"><title>combine::parser::range - 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" href="../../../normalize.css"><link rel="stylesheet" href="../../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../../ayu.css" disabled><link rel="stylesheet" href="../../../dark.css" disabled><link rel="stylesheet" href="../../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../../storage.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"><!--[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">&#9776;</button><a class="sidebar-logo" href="../../../combine/index.html"><div class="logo-container"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../../combine/index.html"><div class="logo-container"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">Module range</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#functions">Functions</a></li></ul></section></div></nav><main><div class="width-limiter"><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"><a href="../../../help.html">?</a></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><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">Module <a href="../../index.html">combine</a>::<wbr><a href="../index.html">parser</a>::<wbr><a class="mod" href="#">range</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></h1><span class="out-of-band"><a class="srclink" href="../../../src/combine/parser/range.rs.html#1-767">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Module containing zero-copy parsers.</p>
<p>These parsers require the <a href="../../stream/trait.RangeStream.html"><code>RangeStream</code></a> bound instead of a plain <a href="../../stream/trait.Stream.html"><code>Stream</code></a>.</p>
</div></details><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.Range.html" title="combine::parser::range::Range struct">Range</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Recognize.html" title="combine::parser::range::Recognize struct">Recognize</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.RecognizeWithValue.html" title="combine::parser::range::RecognizeWithValue struct">RecognizeWithValue</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Take.html" title="combine::parser::range::Take struct">Take</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.TakeFn.html" title="combine::parser::range::TakeFn struct">TakeFn</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.TakeUntilRange.html" title="combine::parser::range::TakeUntilRange struct">TakeUntilRange</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.TakeWhile.html" title="combine::parser::range::TakeWhile struct">TakeWhile</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.TakeWhile1.html" title="combine::parser::range::TakeWhile1 struct">TakeWhile1</a></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.TakeRange.html" title="combine::parser::range::TakeRange enum">TakeRange</a></div></div></div><h2 id="functions" class="small-section-header"><a href="#functions">Functions</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.length_prefix.html" title="combine::parser::range::length_prefix fn">length_prefix</a></div><div class="item-right docblock-short">Takes a parser which parses a <code>length</code> then extracts a range of that length and returns it.
Commonly used in binary formats</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.range.html" title="combine::parser::range::range fn">range</a></div><div class="item-right docblock-short">Zero-copy parser which reads a range of length <code>i.len()</code> and succeeds if <code>i</code> is equal to that
range.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.recognize.html" title="combine::parser::range::recognize fn">recognize</a></div><div class="item-right docblock-short">Zero-copy parser which returns committed input range.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.recognize_with_value.html" title="combine::parser::range::recognize_with_value fn">recognize_with_value</a></div><div class="item-right docblock-short">Zero-copy parser which returns a pair: (committed input range, parsed value).</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.take.html" title="combine::parser::range::take fn">take</a></div><div class="item-right docblock-short">Zero-copy parser which reads a range of length <code>n</code>.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.take_fn.html" title="combine::parser::range::take_fn fn">take_fn</a></div><div class="item-right docblock-short">Searches the entire range using <code>searcher</code> and then consumes a range of <code>Some(n)</code>.
If <code>f</code> can not find anything in the range it must return <code>None/NotFound</code> which indicates an end of input error.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.take_until_range.html" title="combine::parser::range::take_until_range fn">take_until_range</a></div><div class="item-right docblock-short">Zero-copy parser which reads a range of 0 or more tokens until <code>r</code> is found.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.take_while.html" title="combine::parser::range::take_while fn">take_while</a></div><div class="item-right docblock-short">Zero-copy parser which reads a range of 0 or more tokens which satisfy <code>f</code>.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.take_while1.html" title="combine::parser::range::take_while1 fn">take_while1</a></div><div class="item-right docblock-short">Zero-copy parser which reads a range of 1 or more tokens which satisfy <code>f</code>.</div></div></div></section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="combine" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>