blob: 6feeb2b754c09dedfdc9e3f611222ab75cc96420 [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 parsers specialized on byte streams."><meta name="keywords" content="rust, rustlang, rust-lang, byte"><title>combine::parser::byte - 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 byte</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</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="#">byte</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/byte.rs.html#1-678">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 parsers specialized on byte streams.</p>
</div></details><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="num/index.html" title="combine::parser::byte::num mod">num</a></div><div class="item-right docblock-short">Parsers for decoding numbers in big-endian or little-endian order.</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.TakeUntilByte.html" title="combine::parser::byte::TakeUntilByte struct">TakeUntilByte</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.TakeUntilByte2.html" title="combine::parser::byte::TakeUntilByte2 struct">TakeUntilByte2</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.TakeUntilByte3.html" title="combine::parser::byte::TakeUntilByte3 struct">TakeUntilByte3</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.alpha_num.html" title="combine::parser::byte::alpha_num fn">alpha_num</a></div><div class="item-right docblock-short">Parses either an ASCII alphabet letter or digit (a–z, A–Z, 0–9).</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.byte.html" title="combine::parser::byte::byte fn">byte</a></div><div class="item-right docblock-short">Parses a byte and succeeds if the byte is equal to <code>c</code>.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.bytes.html" title="combine::parser::byte::bytes fn">bytes</a></div><div class="item-right docblock-short">Parses the bytes <code>s</code>.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.bytes_cmp.html" title="combine::parser::byte::bytes_cmp fn">bytes_cmp</a></div><div class="item-right docblock-short">Parses the bytes <code>s</code> using <code>cmp</code> to compare each token.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.crlf.html" title="combine::parser::byte::crlf fn">crlf</a></div><div class="item-right docblock-short">Parses carriage return and newline (<code>&amp;b&quot;\r\n&quot;</code>), returning the newline byte.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.digit.html" title="combine::parser::byte::digit fn">digit</a></div><div class="item-right docblock-short">Parses a base-10 digit (0–9).</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.hex_digit.html" title="combine::parser::byte::hex_digit fn">hex_digit</a></div><div class="item-right docblock-short">Parses an ASCII hexdecimal digit (accepts both uppercase and lowercase).</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.letter.html" title="combine::parser::byte::letter fn">letter</a></div><div class="item-right docblock-short">Parses an ASCII alphabet letter (a–z, A–Z).</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.lower.html" title="combine::parser::byte::lower fn">lower</a></div><div class="item-right docblock-short">Parses an lowercase ASCII letter (a–z).</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.newline.html" title="combine::parser::byte::newline fn">newline</a></div><div class="item-right docblock-short">Parses a newline byte (<code>b'\n'</code>).</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.oct_digit.html" title="combine::parser::byte::oct_digit fn">oct_digit</a></div><div class="item-right docblock-short">Parses an octal digit.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.space.html" title="combine::parser::byte::space fn">space</a></div><div class="item-right docblock-short">Parses a <code>b' '</code>, <code>b'\t'</code>, <code>b'\n'</code> or <code>'b\'r'</code>.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.spaces.html" title="combine::parser::byte::spaces fn">spaces</a></div><div class="item-right docblock-short">Skips over <a href="fn.space.html"><code>space</code></a> zero or more times</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.tab.html" title="combine::parser::byte::tab fn">tab</a></div><div class="item-right docblock-short">Parses a tab byte (<code>b'\t'</code>).</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.take_until_byte.html" title="combine::parser::byte::take_until_byte fn">take_until_byte</a></div><div class="item-right docblock-short">Zero-copy parser which reads a range of 0 or more tokens until <code>a</code> is found.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.take_until_byte2.html" title="combine::parser::byte::take_until_byte2 fn">take_until_byte2</a></div><div class="item-right docblock-short">Zero-copy parser which reads a range of 0 or more tokens until <code>a</code> or <code>b</code> is found.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.take_until_byte3.html" title="combine::parser::byte::take_until_byte3 fn">take_until_byte3</a></div><div class="item-right docblock-short">Zero-copy parser which reads a range of 0 or more tokens until <code>a</code>, ‘b’ or <code>c</code> is found.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.take_until_bytes.html" title="combine::parser::byte::take_until_bytes fn">take_until_bytes</a></div><div class="item-right docblock-short">Zero-copy parser which reads a range of 0 or more tokens until <code>needle</code> is found.</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.upper.html" title="combine::parser::byte::upper fn">upper</a></div><div class="item-right docblock-short">Parses an uppercase ASCII letter (A–Z).</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>