Files
greptimedb/common_base/bit_vec/prelude/index.html
2026-05-12 10:47:44 +00:00

8 lines
7.5 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="Symbol Export"><title>common_base::bit_vec::prelude - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../../static.files/rustdoc-17e0aaed.css"><meta name="rustdoc-vars" data-root-path="../../../" data-static-root-path="../../../static.files/" data-current-crate="common_base" data-themes="" data-resource-suffix="" data-rustdoc-version="1.96.0-nightly (ac7f9ec7d 2026-03-20)" data-channel="nightly" data-search-js="search-63369b7b.js" data-stringdex-js="stringdex-2da4960a.js" data-settings-js="settings-170eb4bf.js" ><script src="../../../static.files/storage-41dd4d93.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../../static.files/main-5013f961.js"></script><noscript><link rel="stylesheet" href="../../../static.files/noscript-f7c3ffd8.css"></noscript><link rel="alternate icon" type="image/png" href="../../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../../static.files/favicon-044be391.svg"></head><body class="rustdoc mod"><a class="skip-main-content" href="#main-content">Skip to main content</a><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><rustdoc-topbar><h2><a href="#">Module prelude</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../common_base/index.html">common_<wbr>base</a><span class="version">1.0.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module prelude</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#symbol-export" title="Symbol Export">Symbol Export</a></li></ul><h3><a href="#macros">Module Items</a></h3><ul class="block"><li><a href="#macros" title="Macros">Macros</a></li><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#traits" title="Traits">Traits</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="../index.html">In common_<wbr>base::<wbr>bit_<wbr>vec</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content" tabindex="-1"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../../index.html">common_base</a>::<wbr><a href="../index.html">bit_vec</a></div><h1>Module <span>prelude</span>&nbsp;<button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"></span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><h2 id="symbol-export"><a class="doc-anchor" href="#symbol-export">§</a>Symbol Export</h2>
<p>This module collects the general public API into a single place for bulk import,
as <code>use bitvec::prelude::*;</code>, without polluting the root namespace of the crate.</p>
<p>This provides all the data structure types and macros, as well as the two traits
needed to operate them as type parameters, by name. It also imports extension
traits without naming them, so that their methods are available but their trait
names are not.</p>
</div></details><h2 id="macros" class="section-header">Macros<a href="#macros" class="anchor">§</a></h2><dl class="item-table"><dt><a class="macro" href="macro.BitArr.html" title="macro common_base::bit_vec::prelude::BitArr">BitArr</a></dt><dd>Bit-Array Type Definition</dd><dt><a class="macro" href="macro.bitarr.html" title="macro common_base::bit_vec::prelude::bitarr">bitarr</a></dt><dd>Bit-Array Value Constructor</dd><dt><a class="macro" href="macro.bitbox.html" title="macro common_base::bit_vec::prelude::bitbox">bitbox</a></dt><dd>Boxed Bit-Slice Constructor</dd><dt><a class="macro" href="macro.bits.html" title="macro common_base::bit_vec::prelude::bits">bits</a></dt><dd>Bit-Slice Region Constructor</dd><dt><a class="macro" href="macro.bitvec.html" title="macro common_base::bit_vec::prelude::bitvec">bitvec</a></dt><dd>Bit-Vector Constructor</dd></dl><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.BitArray.html" title="struct common_base::bit_vec::prelude::BitArray">BitArray</a></dt><dd>Bit-Precision Array Immediate</dd><dt><a class="struct" href="struct.BitBox.html" title="struct common_base::bit_vec::prelude::BitBox">BitBox</a></dt><dd>Fixed-Size, Heap-Allocated, Bit Slice</dd><dt><a class="struct" href="struct.BitPtr.html" title="struct common_base::bit_vec::prelude::BitPtr">BitPtr</a></dt><dd>Single-Bit Pointer</dd><dt><a class="struct" href="struct.BitPtrRange.html" title="struct common_base::bit_vec::prelude::BitPtrRange">BitPtr<wbr>Range</a></dt><dd>Bit-Pointer Range</dd><dt><a class="struct" href="struct.BitRef.html" title="struct common_base::bit_vec::prelude::BitRef">BitRef</a></dt><dd>Proxy Bit-Reference</dd><dt><a class="struct" href="struct.BitSlice.html" title="struct common_base::bit_vec::prelude::BitSlice">BitSlice</a></dt><dd>Bit-Addressable Memory</dd><dt><a class="struct" href="struct.BitVec.html" title="struct common_base::bit_vec::prelude::BitVec">BitVec</a></dt><dd>Bit-Precision Dynamic Array</dd><dt><a class="struct" href="struct.LocalBits.html" title="struct common_base::bit_vec::prelude::LocalBits">Local<wbr>Bits</a></dt><dd>Least-Significant-First Bit Traversal</dd><dt><a class="struct" href="struct.Lsb0.html" title="struct common_base::bit_vec::prelude::Lsb0">Lsb0</a></dt><dd>Least-Significant-First Bit Traversal</dd><dt><a class="struct" href="struct.Msb0.html" title="struct common_base::bit_vec::prelude::Msb0">Msb0</a></dt><dd>Most-Significant-First Bit Traversal</dd></dl><h2 id="traits" class="section-header">Traits<a href="#traits" class="anchor">§</a></h2><dl class="item-table"><dt><a class="trait" href="trait.AsBits.html" title="trait common_base::bit_vec::prelude::AsBits">AsBits</a></dt><dd>Immutable Bit View</dd><dt><a class="trait" href="trait.AsMutBits.html" title="trait common_base::bit_vec::prelude::AsMutBits">AsMut<wbr>Bits</a></dt><dd>Mutable Bit View</dd><dt><a class="trait" href="trait.BitOrder.html" title="trait common_base::bit_vec::prelude::BitOrder">BitOrder</a></dt><dd>In-Element Bit Ordering</dd><dt><a class="trait" href="trait.BitStore.html" title="trait common_base::bit_vec::prelude::BitStore">BitStore</a></dt><dd>Bit Storage</dd><dt><a class="trait" href="trait._.html" title="trait common_base::bit_vec::prelude::_">_</a></dt><dd>C-Style Bit-Field Access</dd><dt><a class="trait" href="trait._.html" title="trait common_base::bit_vec::prelude::_">_</a></dt><dd>Bit View</dd><dt><a class="trait" href="trait._.html" title="trait common_base::bit_vec::prelude::_">_</a></dt><dd>Helper trait for scalars and arrays, but not slices.</dd></dl></section></div></main></body></html>