edg-l/edlang
1
1
Fork 0
mirror of https://github.com/edg-l/edlang.git synced 2024-11-10 01:58:23 +00:00
Code Issues Packages Projects Releases Wiki Activity
edlang/winnow/binary/fn.le_i16.html

26 lines
7.4 KiB
HTML
Raw Normal View History

deploy: 637aa8e2291c53c3cd46480c4f94db27586c677b
2024-05-07 06:31:16 +00:00
<!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="Recognizes a little endian signed 2 bytes integer."><title>le_i16 in winnow::binary - Rust</title><script> if (window.location.protocol !== "file:") document.write(`<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">`)</script><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-e935ef01ae1c1829.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.78.0 (9b00956e5 2024-04-29)" data-channel="1.78.0" data-search-js="search-42d8da7a6b9792c2.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../static.files/storage-4c98445ec4002617.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-12cf3b4f4f9dc36d.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-04d5337699b92874.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" 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.8</span></h2></div><div class="sidebar-elems"><h2><a href="index.html">In winnow::binary</a></h2></div></nav><div class="sidebar-resizer"></div>
deploy: 03a244db41b752280f505ceeaea877cc9b95537b
2024-05-05 09:43:20 +00:00
<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 class="fn" href="#">le_i16</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/mod.rs.html#998-1008">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><pre class="rust item-decl"><code>pub fn le_i16&lt;Input, Error&gt;(input: <a class="primitive" href="https://doc.rust-lang.org/1.78.0/std/primitive.reference.html">&amp;mut Input</a>) -&gt; <a class="type" href="../error/type.PResult.html" title="type winnow::error::PResult">PResult</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.78.0/std/primitive.i16.html">i16</a>, Error&gt;<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>&lt;Token = <a class="primitive" href="https://doc.rust-lang.org/1.78.0/std/primitive.u8.html">u8</a>&gt;,
deploy: 22498719e1dbb1ddc4a5584a4fcba2f337ccb991
2024-03-11 08:39:13 +00:00
&lt;Input as <a class="trait" href="../stream/trait.Stream.html" title="trait winnow::stream::Stream">Stream</a>&gt;::<a class="associatedtype" href="../stream/trait.Stream.html#associatedtype.Slice" title="type winnow::stream::Stream::Slice">Slice</a>: <a class="trait" href="../stream/trait.AsBytes.html" title="trait winnow::stream::AsBytes">AsBytes</a>,
Error: <a class="trait" href="../error/trait.ParserError.html" title="trait winnow::error::ParserError">ParserError</a>&lt;Input&gt;,</div></code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Recognizes a little endian signed 2 bytes integer.</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>
deploy: 39fc7f2b9fd58ce67982b1c71c788f3b031ae3df
2024-03-27 11:12:16 +00:00
<h2 id="example"><a class="doc-anchor" href="#example">§</a>Example</h2>
deploy: 22498719e1dbb1ddc4a5584a4fcba2f337ccb991
2024-03-11 08:39:13 +00:00
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>winnow::binary::le_i16;
<span class="kw">fn </span>parser(s: <span class="kw-2">&amp;</span>[u8]) -&gt; IResult&lt;<span class="kw-2">&amp;</span>[u8], i16&gt; {
le_i16.parse_peek(s)
}
<span class="macro">assert_eq!</span>(parser(<span class="kw-2">&amp;</span><span class="string">b"\x00\x03abcefg"</span>[..]), <span class="prelude-val">Ok</span>((<span class="kw-2">&amp;</span><span class="string">b"abcefg"</span>[..], <span class="number">0x0300</span>)));
<span class="macro">assert_eq!</span>(parser(<span class="kw-2">&amp;</span><span class="string">b"\x01"</span>[..]), <span class="prelude-val">Err</span>(ErrMode::Backtrack(InputError::new(<span class="kw-2">&amp;</span>[<span class="number">0x01</span>][..], ErrorKind::Slice))));</code></pre></div>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>winnow::binary::le_i16;
<span class="kw">fn </span>parser(s: Partial&lt;<span class="kw-2">&amp;</span>[u8]&gt;) -&gt; IResult&lt;Partial&lt;<span class="kw-2">&amp;</span>[u8]&gt;, i16&gt; {
le_i16::&lt;<span class="kw">_</span>, InputError&lt;<span class="kw">_</span>&gt;&gt;.parse_peek(s)
}
<span class="macro">assert_eq!</span>(parser(Partial::new(<span class="kw-2">&amp;</span><span class="string">b"\x00\x01abcd"</span>[..])), <span class="prelude-val">Ok</span>((Partial::new(<span class="kw-2">&amp;</span><span class="string">b"abcd"</span>[..]), <span class="number">0x0100</span>)));
<span class="macro">assert_eq!</span>(parser(Partial::new(<span class="kw-2">&amp;</span><span class="string">b"\x01"</span>[..])), <span class="prelude-val">Err</span>(ErrMode::Incomplete(Needed::new(<span class="number">1</span>))));</code></pre></div>
</div></details></section></div></main></body></html>
Reference in a new issue Copy permalink