mirror of
https://github.com/edg-l/edlang.git
synced 2024-11-09 17:48:24 +00:00
29 lines
6 KiB
HTML
29 lines
6 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="Get a length-prefixed slice (TLV)"><title>length_take in winnow::binary - 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</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 class="fn" href="#">length_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/mod.rs.html#2407-2421">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub fn length_take<Input, Count, Error, CountParser>(
|
|
count: CountParser,
|
|
) -> impl <a class="trait" href="../trait.Parser.html" title="trait winnow::Parser">Parser</a><Input, <Input as <a class="trait" href="../stream/trait.Stream.html" title="trait winnow::stream::Stream">Stream</a>>::<a class="associatedtype" href="../stream/trait.Stream.html#associatedtype.Slice" title="type winnow::stream::Stream::Slice">Slice</a>, Error><div class="where">where
|
|
Input: <a class="trait" href="../stream/trait.StreamIsPartial.html" title="trait winnow::stream::StreamIsPartial">StreamIsPartial</a> + <a class="trait" href="../stream/trait.Stream.html" title="trait winnow::stream::Stream">Stream</a>,
|
|
Count: <a class="trait" href="../stream/trait.ToUsize.html" title="trait winnow::stream::ToUsize">ToUsize</a>,
|
|
CountParser: <a class="trait" href="../trait.Parser.html" title="trait winnow::Parser">Parser</a><Input, Count, Error>,
|
|
Error: <a class="trait" href="../error/trait.ParserError.html" title="trait winnow::error::ParserError">ParserError</a><Input>,</div></code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Get a length-prefixed slice (<a href="https://en.wikipedia.org/wiki/Type-length-value">TLV</a>)</p>
|
|
<p>To apply a parser to the returned slice, see <a href="fn.length_and_then.html" title="fn winnow::binary::length_and_then"><code>length_and_then</code></a>.</p>
|
|
<p>If the count is for something besides tokens, see <a href="fn.length_repeat.html" title="fn winnow::binary::length_repeat"><code>length_repeat</code></a>.</p>
|
|
<p><em>Complete version</em>: Returns an error if there is not enough input data.</p>
|
|
<p><em>[Partial version][crate::_topic::partial]</em>: Will return <code>Err(winnow::error::ErrMode::Incomplete(_))</code> if there is not enough data.</p>
|
|
<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::Bytes;
|
|
<span class="kw">use </span>winnow::binary::be_u16;
|
|
<span class="kw">use </span>winnow::binary::length_take;
|
|
|
|
<span class="kw">type </span>Stream<<span class="lifetime">'i</span>> = Partial<<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>> {
|
|
Partial::new(Bytes::new(b))
|
|
}
|
|
|
|
<span class="kw">fn </span>parser(s: Stream<<span class="lifetime">'_</span>>) -> IResult<Stream<<span class="lifetime">'_</span>>, <span class="kw-2">&</span>[u8]> {
|
|
length_take(be_u16).parse_peek(s)
|
|
}
|
|
|
|
<span class="macro">assert_eq!</span>(parser(stream(<span class="string">b"\x00\x03abcefg"</span>)), <span class="prelude-val">Ok</span>((stream(<span class="kw-2">&</span><span class="string">b"efg"</span>[..]), <span class="kw-2">&</span><span class="string">b"abc"</span>[..])));
|
|
<span class="macro">assert_eq!</span>(parser(stream(<span class="string">b"\x00\x03a"</span>)), <span class="prelude-val">Err</span>(ErrMode::Incomplete(Needed::new(<span class="number">2</span>))));</code></pre></div>
|
|
</div></details></section></div></main></body></html> |