mirror of
https://github.com/edg-l/edlang.git
synced 2024-11-23 16:38:24 +00:00
58 lines
10 KiB
HTML
58 lines
10 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="Parse taking `count` bits and comparing them to `pattern`"><title>pattern in winnow::binary::bits - 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="winnow" 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 fn"><!--[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="../../../winnow/index.html">winnow</a><span class="version">0.6.5</span></h2></div><div class="sidebar-elems"><h2><a href="index.html">In winnow::binary::bits</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="../../../winnow/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>Function <a href="../../index.html">winnow</a>::<wbr><a href="../index.html">binary</a>::<wbr><a href="index.html">bits</a>::<wbr><a class="fn" href="#">pattern</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/winnow/binary/bits/mod.rs.html#336-365">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub fn pattern<Input, Output, Count, Error: <a class="trait" href="../../error/trait.ParserError.html" title="trait winnow::error::ParserError">ParserError</a><(Input, <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.usize.html">usize</a>)>>(
|
||
pattern: Output,
|
||
count: Count
|
||
) -> impl <a class="trait" href="../../trait.Parser.html" title="trait winnow::Parser">Parser</a><(Input, <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.usize.html">usize</a>), Output, Error><div class="where">where
|
||
Input: <a class="trait" href="../../stream/trait.Stream.html" title="trait winnow::stream::Stream">Stream</a><Token = <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.u8.html">u8</a>> + <a class="trait" href="../../stream/trait.AsBytes.html" title="trait winnow::stream::AsBytes">AsBytes</a> + <a class="trait" href="../../stream/trait.StreamIsPartial.html" title="trait winnow::stream::StreamIsPartial">StreamIsPartial</a> + <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,
|
||
Count: <a class="trait" href="../../stream/trait.ToUsize.html" title="trait winnow::stream::ToUsize">ToUsize</a>,
|
||
Output: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.u8.html">u8</a>> + <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/ops/arith/trait.AddAssign.html" title="trait core::ops::arith::AddAssign">AddAssign</a> + <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/ops/bit/trait.Shl.html" title="trait core::ops::bit::Shl">Shl</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.usize.html">usize</a>, Output = Output> + <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/ops/bit/trait.Shr.html" title="trait core::ops::bit::Shr">Shr</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.usize.html">usize</a>, Output = Output> + <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a>,</div></code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Parse taking <code>count</code> bits and comparing them to <code>pattern</code></p>
|
||
<h2 id="effective-signature"><a href="#effective-signature">Effective Signature</a></h2>
|
||
<p>Assuming you are parsing a <code>(&[u8], usize)</code> bit <a href="../../stream/trait.Stream.html" title="trait winnow::stream::Stream">Stream</a>:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">pub fn </span>pattern<<span class="lifetime">'i</span>>(pattern: u8, count: usize) -> <span class="kw">impl </span>Parser<(<span class="kw-2">&</span><span class="lifetime">'i </span>[u8], usize), u8, ContextError></code></pre></div>
|
||
<h2 id="example"><a href="#example">Example</a></h2>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>winnow::binary::bits::pattern;
|
||
|
||
<span class="kw">type </span>Stream<<span class="lifetime">'i</span>> = <span class="kw-2">&</span><span class="lifetime">'i </span>Bytes;
|
||
|
||
<span class="kw">fn </span>stream(b: <span class="kw-2">&</span>[u8]) -> Stream<<span class="lifetime">'_</span>> {
|
||
Bytes::new(b)
|
||
}
|
||
|
||
<span class="doccomment">/// Compare the lowest `count` bits of `input` against the lowest `count` bits of `pattern`.
|
||
/// Return Ok and the matching section of `input` if there's a match.
|
||
/// Return Err if there's no match.
|
||
</span><span class="kw">fn </span>parser(bits: u8, count: u8, input: (Stream<<span class="lifetime">'_</span>>, usize)) -> IResult<(Stream<<span class="lifetime">'_</span>>, usize), u8> {
|
||
pattern(bits, count).parse_peek(input)
|
||
}
|
||
|
||
<span class="comment">// The lowest 4 bits of 0b00001111 match the lowest 4 bits of 0b11111111.
|
||
</span><span class="macro">assert_eq!</span>(
|
||
parser(<span class="number">0b0000_1111</span>, <span class="number">4</span>, (stream(<span class="kw-2">&</span>[<span class="number">0b1111_1111</span>]), <span class="number">0</span>)),
|
||
<span class="prelude-val">Ok</span>(((stream(<span class="kw-2">&</span>[<span class="number">0b1111_1111</span>]), <span class="number">4</span>), <span class="number">0b0000_1111</span>))
|
||
);
|
||
|
||
<span class="comment">// The lowest bit of 0b00001111 matches the lowest bit of 0b11111111 (both are 1).
|
||
</span><span class="macro">assert_eq!</span>(
|
||
parser(<span class="number">0b00000001</span>, <span class="number">1</span>, (stream(<span class="kw-2">&</span>[<span class="number">0b11111111</span>]), <span class="number">0</span>)),
|
||
<span class="prelude-val">Ok</span>(((stream(<span class="kw-2">&</span>[<span class="number">0b11111111</span>]), <span class="number">1</span>), <span class="number">0b00000001</span>))
|
||
);
|
||
|
||
<span class="comment">// The lowest 2 bits of 0b11111111 and 0b00000001 are different.
|
||
</span><span class="macro">assert_eq!</span>(
|
||
parser(<span class="number">0b000000_01</span>, <span class="number">2</span>, (stream(<span class="kw-2">&</span>[<span class="number">0b111111_11</span>]), <span class="number">0</span>)),
|
||
<span class="prelude-val">Err</span>(winnow::error::ErrMode::Backtrack(InputError::new(
|
||
(stream(<span class="kw-2">&</span>[<span class="number">0b11111111</span>]), <span class="number">0</span>),
|
||
ErrorKind::Tag
|
||
)))
|
||
);
|
||
|
||
<span class="comment">// The lowest 8 bits of 0b11111111 and 0b11111110 are different.
|
||
</span><span class="macro">assert_eq!</span>(
|
||
parser(<span class="number">0b11111110</span>, <span class="number">8</span>, (stream(<span class="kw-2">&</span>[<span class="number">0b11111111</span>]), <span class="number">0</span>)),
|
||
<span class="prelude-val">Err</span>(winnow::error::ErrMode::Backtrack(InputError::new(
|
||
(stream(<span class="kw-2">&</span>[<span class="number">0b11111111</span>]), <span class="number">0</span>),
|
||
ErrorKind::Tag
|
||
)))
|
||
);</code></pre></div>
|
||
</div></details></section></div></main></body></html> |