mirror of
https://github.com/edg-l/edlang.git
synced 2024-11-10 01:58:23 +00:00
36 lines
8.2 KiB
HTML
36 lines
8.2 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"><title>take in winnow::binary::bits - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../../static.files/rustdoc-dd39b87e5fcfba68.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.80.0 (051478957 2024-07-21)" data-channel="1.80.0" data-search-js="search-d52510db62a78183.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../../static.files/storage-118b08c4c78b968e.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../../static.files/main-20a3ad099b048cf2.js"></script><noscript><link rel="stylesheet" href="../../../static.files/noscript-df360f571f6edeae.css"></noscript><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" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../winnow/index.html">winnow</a><span class="version">0.6.16</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"><rustdoc-search></rustdoc-search><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="#">take</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><a class="src" href="../../../src/winnow/binary/bits/mod.rs.html#193-211">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub fn take<Input, Output, Count, Error>(
|
|
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.80.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.80.0/std/primitive.u8.html">u8</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.80.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,
|
|
Output: <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.u8.html">u8</a>> + <a class="trait" href="https://doc.rust-lang.org/1.80.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.80.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.80.0/std/primitive.usize.html">usize</a>, Output = Output> + <a class="trait" href="https://doc.rust-lang.org/1.80.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.80.0/std/primitive.usize.html">usize</a>, Output = Output>,
|
|
Count: <a class="trait" href="../../stream/trait.ToUsize.html" title="trait winnow::stream::ToUsize">ToUsize</a>,
|
|
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.80.0/std/primitive.usize.html">usize</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</p>
|
|
<h2 id="effective-signature"><a class="doc-anchor" href="#effective-signature">§</a>Effective Signature</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>take<<span class="lifetime">'i</span>>(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 class="doc-anchor" href="#example">§</a>Example</h2>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>winnow::binary::bits::take;
|
|
|
|
<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="kw">fn </span>parser(input: (Stream<<span class="lifetime">'_</span>>, usize), count: usize)-> IResult<(Stream<<span class="lifetime">'_</span>>, usize), u8> {
|
|
take(count).parse_peek(input)
|
|
}
|
|
|
|
<span class="comment">// Consumes 0 bits, returns 0
|
|
</span><span class="macro">assert_eq!</span>(parser((stream(<span class="kw-2">&</span>[<span class="number">0b00010010</span>]), <span class="number">0</span>), <span class="number">0</span>), <span class="prelude-val">Ok</span>(((stream(<span class="kw-2">&</span>[<span class="number">0b00010010</span>]), <span class="number">0</span>), <span class="number">0</span>)));
|
|
|
|
<span class="comment">// Consumes 4 bits, returns their values and increase offset to 4
|
|
</span><span class="macro">assert_eq!</span>(parser((stream(<span class="kw-2">&</span>[<span class="number">0b00010010</span>]), <span class="number">0</span>), <span class="number">4</span>), <span class="prelude-val">Ok</span>(((stream(<span class="kw-2">&</span>[<span class="number">0b00010010</span>]), <span class="number">4</span>), <span class="number">0b00000001</span>)));
|
|
|
|
<span class="comment">// Consumes 4 bits, offset is 4, returns their values and increase offset to 0 of next byte
|
|
</span><span class="macro">assert_eq!</span>(parser((stream(<span class="kw-2">&</span>[<span class="number">0b00010010</span>]), <span class="number">4</span>), <span class="number">4</span>), <span class="prelude-val">Ok</span>(((stream(<span class="kw-2">&</span>[]), <span class="number">0</span>), <span class="number">0b00000010</span>)));
|
|
|
|
<span class="comment">// Tries to consume 12 bits but only 8 are available
|
|
</span><span class="macro">assert_eq!</span>(parser((stream(<span class="kw-2">&</span>[<span class="number">0b00010010</span>]), <span class="number">0</span>), <span class="number">12</span>), <span class="prelude-val">Err</span>(winnow::error::ErrMode::Backtrack(InputError::new((stream(<span class="kw-2">&</span>[<span class="number">0b00010010</span>]), <span class="number">0</span>), ErrorKind::Eof))));</code></pre></div>
|
|
</div></details></section></div></main></body></html> |