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 = "Converts a byte-level input to a bit-level input" > < title > bits 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 = "#" > bits< / 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#49-79" > source< / a > · < button id = "toggle-all-docs" title = "collapse all docs" > [< span > − < / span > ]< / button > < / span > < / div > < pre class = "rust item-decl" > < code > pub fn bits< Input, Output, BitError, ByteError, ParseNext> (
2024-07-26 09:42:18 +00:00
parser: ParseNext,
2024-03-11 08:39:13 +00:00
) -> impl < a class = "trait" href = "../../trait.Parser.html" title = "trait winnow::Parser" > Parser< / a > < Input, Output, ByteError> < div class = "where" > where
2024-07-26 09:42:18 +00:00
BitError: < 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 > )> + < a class = "trait" href = "../../error/trait.ErrorConvert.html" title = "trait winnow::error::ErrorConvert" > ErrorConvert< / a > < ByteError> ,
2024-03-11 08:39:13 +00:00
ByteError: < a class = "trait" href = "../../error/trait.ParserError.html" title = "trait winnow::error::ParserError" > ParserError< / a > < Input> ,
2024-07-26 09:42:18 +00:00
(Input, < a class = "primitive" href = "https://doc.rust-lang.org/1.80.0/std/primitive.usize.html" > usize< / a > ): < a class = "trait" href = "../../stream/trait.Stream.html" title = "trait winnow::stream::Stream" > Stream< / a > ,
Input: < a class = "trait" href = "../../stream/trait.Stream.html" title = "trait winnow::stream::Stream" > Stream< / 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 > ,
ParseNext: < 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, BitError> ,< / div > < / code > < / pre > < details class = "toggle top-doc" open > < summary class = "hideme" > < span > Expand description< / span > < / summary > < div class = "docblock" > < p > Converts a byte-level input to a bit-level input< / p >
2024-03-11 08:39:13 +00:00
< p > See < a href = "fn.bytes.html" title = "fn winnow::binary::bits::bytes" > < code > bytes< / code > < / a > to convert it back.< / p >
2024-03-27 11:12:16 +00:00
< h2 id = "example" > < a class = "doc-anchor" href = "#example" > §< / a > Example< / h2 >
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::prelude::< span class = "kw-2" > *< / span > ;
< span class = "kw" > use < / span > winnow::Bytes;
< span class = "kw" > use < / span > winnow::binary::bits::{bits, take};
< span class = "kw" > use < / span > winnow::error::InputError;
< 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 > parse(input: Stream< < span class = "lifetime" > '_< / span > > ) -> IResult< Stream< < span class = "lifetime" > '_< / span > > , (u8, u8)> {
bits::< < span class = "kw" > _< / span > , < span class = "kw" > _< / span > , InputError< (< span class = "kw" > _< / span > , usize)> , < span class = "kw" > _< / span > , < span class = "kw" > _< / span > > ((take(< span class = "number" > 4usize< / span > ), take(< span class = "number" > 8usize< / span > ))).parse_peek(input)
}
< span class = "kw" > let < / span > input = stream(< span class = "kw-2" > & < / span > [< span class = "number" > 0x12< / span > , < span class = "number" > 0x34< / span > , < span class = "number" > 0xff< / span > , < span class = "number" > 0xff< / span > ]);
< span class = "kw" > let < / span > output = parse(input).expect(< span class = "string" > "We take 1.5 bytes and the input is longer than 2 bytes"< / span > );
< span class = "comment" > // The first byte is consumed, the second byte is partially consumed and dropped.
< / span > < span class = "kw" > let < / span > remaining = output.< span class = "number" > 0< / span > ;
< span class = "macro" > assert_eq!< / span > (remaining, stream(< span class = "kw-2" > & < / span > [< span class = "number" > 0xff< / span > , < span class = "number" > 0xff< / span > ]));
< span class = "kw" > let < / span > parsed = output.< span class = "number" > 1< / span > ;
< span class = "macro" > assert_eq!< / span > (parsed.< span class = "number" > 0< / span > , < span class = "number" > 0x01< / span > );
< span class = "macro" > assert_eq!< / span > (parsed.< span class = "number" > 1< / span > , < span class = "number" > 0x23< / span > );< / code > < / pre > < / div >
< / div > < / details > < / section > < / div > < / main > < / body > < / html >