edg-l/edlang
1
1
Fork 0
mirror of https://github.com/edg-l/edlang.git synced 2024-10-18 15:08:17 +00:00
Code Issues Packages Projects Releases Wiki Activity
edlang/winnow/binary/bits/fn.bool.html

24 lines
6.1 KiB
HTML
Raw Permalink Normal View History

deploy: 0d39a300f5fe3e8ab07cda8b36c3b377b69cbdff
2024-08-01 07:04:26 +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="Parses one specific bit as a bool."><title>bool 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.18</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="#">bool</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#403-414">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 bool&lt;Input, Error: <a class="trait" href="../../error/trait.ParserError.html" title="trait winnow::error::ParserError">ParserError</a>&lt;(Input, <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.usize.html">usize</a>)&gt;&gt;(
deploy: b3bd34a9bbae9c73eb2d66a212d6921bd7499b69
2024-07-26 09:42:18 +00:00
input: &amp;mut (Input, <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.usize.html">usize</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.80.0/std/primitive.bool.html">bool</a>, Error&gt;<div class="where">where
Input: <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.80.0/std/primitive.u8.html">u8</a>&gt; + <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>,</div></code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Parses one specific bit as a bool.</p>
deploy: 39fc7f2b9fd58ce67982b1c71c788f3b031ae3df
2024-03-27 11:12:16 +00:00
<h2 id="effective-signature"><a class="doc-anchor" href="#effective-signature">§</a>Effective Signature</h2>
deploy: 22498719e1dbb1ddc4a5584a4fcba2f337ccb991
2024-03-11 08:39:13 +00:00
<p>Assuming you are parsing a <code>(&amp;[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>bool(input: <span class="kw-2">&amp;mut </span>(<span class="kw-2">&amp;</span>[u8], usize)) -&gt; PResult&lt;bool&gt;</code></pre></div>
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::bits::bool;
<span class="kw">type </span>Stream&lt;<span class="lifetime">'i</span>&gt; = <span class="kw-2">&amp;</span><span class="lifetime">'i </span>Bytes;
<span class="kw">fn </span>stream(b: <span class="kw-2">&amp;</span>[u8]) -&gt; Stream&lt;<span class="lifetime">'_</span>&gt; {
Bytes::new(b)
}
<span class="kw">fn </span>parse(input: (Stream&lt;<span class="lifetime">'_</span>&gt;, usize)) -&gt; IResult&lt;(Stream&lt;<span class="lifetime">'_</span>&gt;, usize), bool&gt; {
bool.parse_peek(input)
}
<span class="macro">assert_eq!</span>(parse((stream(<span class="kw-2">&amp;</span>[<span class="number">0b10000000</span>]), <span class="number">0</span>)), <span class="prelude-val">Ok</span>(((stream(<span class="kw-2">&amp;</span>[<span class="number">0b10000000</span>]), <span class="number">1</span>), <span class="bool-val">true</span>)));
<span class="macro">assert_eq!</span>(parse((stream(<span class="kw-2">&amp;</span>[<span class="number">0b10000000</span>]), <span class="number">1</span>)), <span class="prelude-val">Ok</span>(((stream(<span class="kw-2">&amp;</span>[<span class="number">0b10000000</span>]), <span class="number">2</span>), <span class="bool-val">false</span>)));</code></pre></div>
</div></details></section></div></main></body></html>
Reference in a new issue Copy permalink