rust/tantivy
1
0
Fork 0
mirror of https://github.com/quickwit-oss/tantivy.git synced 2026-05-26 13:10:41 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
63a070c83236ffc691830bf40bb4701e07e2b4ac
tantivy/master/combine/parser/byte/index.html
Travis CI User 63a070c832 Automatic Travis documentation build
2019-06-16 03:00:46 +00:00

25 lines
12 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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="API documentation for the Rust `byte` mod in crate `combine`."><meta name="keywords" content="rust, rustlang, rust-lang, byte"><title>combine::parser::byte - Rust</title><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="../../../dark.css"><link rel="stylesheet" type="text/css" href="../../../light.css" id="themeStyle"><script src="../../../storage.js"></script><noscript><link rel="stylesheet" href="../../../noscript.css"></noscript><link rel="shortcut icon" href="../../../favicon.ico"><style type="text/css">#crate-search{background-image:url("../../../down-arrow.svg");}</style></head><body class="rustdoc mod"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">&#9776;</div><a href='../../../combine/index.html'><img src='../../../rust-logo.png' alt='logo' width='100'></a><p class='location'>Module byte</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li><li><a href="#functions">Functions</a></li></ul></div><p class='location'><a href='../../index.html'>combine</a>::<wbr><a href='../index.html'>parser</a></p><script>window.sidebarCurrent = {name: 'byte', ty: 'mod', relpath: '../'};</script><script defer src="../sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../../../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><a id="settings-menu" href="../../../settings.html"><img src="../../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>&#x2212;</span>]</a></span><a class='srclink' href='../../../src/combine/parser/byte.rs.html#1-783' title='goto source code'>[src]</a></span><span class='in-band'>Module <a href='../../index.html'>combine</a>::<wbr><a href='../index.html'>parser</a>::<wbr><a class="mod" href=''>byte</a></span></h1><div class='docblock'><p>Module containing parsers specialized on byte streams.</p>
</div><h2 id='modules' class='section-header'><a href="#modules">Modules</a></h2>
<table><tr class='module-item'><td><a class="mod" href="num/index.html" title='combine::parser::byte::num mod'>num</a></td><td class='docblock-short'><p>Parsers for decoding numbers in big-endian or little-endian order.</p>
</td></tr></table><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
<table><tr class='module-item'><td><a class="struct" href="struct.AlphaNum.html" title='combine::parser::byte::AlphaNum struct'>AlphaNum</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.Bytes.html" title='combine::parser::byte::Bytes struct'>Bytes</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.BytesCmp.html" title='combine::parser::byte::BytesCmp struct'>BytesCmp</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.CrLf.html" title='combine::parser::byte::CrLf struct'>CrLf</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.Digit.html" title='combine::parser::byte::Digit struct'>Digit</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.HexDigit.html" title='combine::parser::byte::HexDigit struct'>HexDigit</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.Letter.html" title='combine::parser::byte::Letter struct'>Letter</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.Lower.html" title='combine::parser::byte::Lower struct'>Lower</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.Newline.html" title='combine::parser::byte::Newline struct'>Newline</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.OctDigit.html" title='combine::parser::byte::OctDigit struct'>OctDigit</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.Space.html" title='combine::parser::byte::Space struct'>Space</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.Spaces.html" title='combine::parser::byte::Spaces struct'>Spaces</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.Tab.html" title='combine::parser::byte::Tab struct'>Tab</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.TakeUntilByte.html" title='combine::parser::byte::TakeUntilByte struct'>TakeUntilByte</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.TakeUntilByte2.html" title='combine::parser::byte::TakeUntilByte2 struct'>TakeUntilByte2</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.TakeUntilByte3.html" title='combine::parser::byte::TakeUntilByte3 struct'>TakeUntilByte3</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.Upper.html" title='combine::parser::byte::Upper struct'>Upper</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.take_until_bytes.html" title='combine::parser::byte::take_until_bytes struct'>take_until_bytes</a></td><td class='docblock-short'></td></tr></table><h2 id='functions' class='section-header'><a href="#functions">Functions</a></h2>
<table><tr class='module-item'><td><a class="fn" href="fn.alpha_num.html" title='combine::parser::byte::alpha_num fn'>alpha_num</a></td><td class='docblock-short'><p>Parses either an ASCII alphabet letter or digit (a–z, A–Z, 0–9).</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.byte.html" title='combine::parser::byte::byte fn'>byte</a></td><td class='docblock-short'><p>Parses a byte and succeeds if the byte is equal to <code>c</code>.</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.bytes.html" title='combine::parser::byte::bytes fn'>bytes</a></td><td class='docblock-short'><p>Parses the bytes <code>s</code>.</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.bytes_cmp.html" title='combine::parser::byte::bytes_cmp fn'>bytes_cmp</a></td><td class='docblock-short'><p>Parses the bytes <code>s</code> using <code>cmp</code> to compare each token.</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.crlf.html" title='combine::parser::byte::crlf fn'>crlf</a></td><td class='docblock-short'><p>Parses carriage return and newline (<code>&amp;b&quot;\r\n&quot;</code>), returning the newline byte.</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.digit.html" title='combine::parser::byte::digit fn'>digit</a></td><td class='docblock-short'><p>Parses a base-10 digit (0–9).</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.hex_digit.html" title='combine::parser::byte::hex_digit fn'>hex_digit</a></td><td class='docblock-short'><p>Parses an ASCII hexdecimal digit (accepts both uppercase and lowercase).</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.letter.html" title='combine::parser::byte::letter fn'>letter</a></td><td class='docblock-short'><p>Parses an ASCII alphabet letter (a–z, A–Z).</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.lower.html" title='combine::parser::byte::lower fn'>lower</a></td><td class='docblock-short'><p>Parses an lowercase ASCII letter (a–z).</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.newline.html" title='combine::parser::byte::newline fn'>newline</a></td><td class='docblock-short'><p>Parses a newline byte (<code>b'\n'</code>).</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.oct_digit.html" title='combine::parser::byte::oct_digit fn'>oct_digit</a></td><td class='docblock-short'><p>Parses an octal digit.</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.space.html" title='combine::parser::byte::space fn'>space</a></td><td class='docblock-short'><p>Parses a <code>b' '</code>, <code>b'\t'</code>, <code>b'\n'</code> or <code>'b\'r'</code>.</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.spaces.html" title='combine::parser::byte::spaces fn'>spaces</a></td><td class='docblock-short'><p>Skips over <a href="fn.space.html"><code>space</code></a> zero or more times</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.tab.html" title='combine::parser::byte::tab fn'>tab</a></td><td class='docblock-short'><p>Parses a tab byte (<code>b'\t'</code>).</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.take_until_byte.html" title='combine::parser::byte::take_until_byte fn'>take_until_byte</a></td><td class='docblock-short'><p>Zero-copy parser which reads a range of 0 or more tokens until <code>a</code> is found.</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.take_until_byte2.html" title='combine::parser::byte::take_until_byte2 fn'>take_until_byte2</a></td><td class='docblock-short'><p>Zero-copy parser which reads a range of 0 or more tokens until <code>a</code> or <code>b</code> is found.</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.take_until_byte3.html" title='combine::parser::byte::take_until_byte3 fn'>take_until_byte3</a></td><td class='docblock-short'><p>Zero-copy parser which reads a range of 0 or more tokens until <code>a</code>, 'b' or <code>c</code> is found.</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.take_until_bytes.html" title='combine::parser::byte::take_until_bytes fn'>take_until_bytes</a></td><td class='docblock-short'><p>Zero-copy parser which reads a range of 0 or more tokens until <code>needle</code> is found.</p>
</td></tr><tr class='module-item'><td><a class="fn" href="fn.upper.html" title='combine::parser::byte::upper fn'>upper</a></td><td class='docblock-short'><p>Parses an uppercase ASCII letter (A–Z).</p>
</td></tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>&#9166;</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g., <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g., <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g., <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../../../";window.currentCrate = "combine";</script><script src="../../../aliases.js"></script><script src="../../../main.js"></script><script defer src="../../../search-index.js"></script></body></html>
Reference in New Issue View Git Blame Copy Permalink