bitvec/
lib.rs

1#![doc = include_str!("../README.md")]
2#![cfg_attr(not(feature = "std"), no_std)]
3#![cfg_attr(
4	debug_assertions,
5	warn(missing_docs, clippy::missing_docs_in_private_items)
6)]
7#![cfg_attr(
8	not(debug_assertions),
9	deny(missing_docs, clippy::missing_docs_in_private_items)
10)]
11#![deny(unconditional_recursion)]
12#![allow(
13	clippy::declare_interior_mutable_const,
14	clippy::type_complexity,
15	unknown_lints
16)]
17
18#[cfg(feature = "alloc")]
19extern crate alloc;
20
21#[macro_use]
22mod devel;
23
24#[macro_use]
25pub mod macros;
26
27pub mod access;
28pub mod array;
29pub mod boxed;
30pub mod domain;
31pub mod field;
32pub mod index;
33pub mod mem;
34pub mod order;
35pub mod ptr;
36mod serdes;
37pub mod slice;
38pub mod store;
39pub mod vec;
40pub mod view;
41
42#[doc = include_str!("../doc/prelude.md")]
43pub mod prelude {
44	pub use crate::{
45		array::BitArray,
46		bitarr,
47		bits,
48		field::BitField as _,
49		order::{
50			BitOrder,
51			LocalBits,
52			Lsb0,
53			Msb0,
54		},
55		ptr::{
56			BitPtr,
57			BitPtrRange,
58			BitRef,
59		},
60		slice::BitSlice,
61		store::BitStore,
62		view::{
63			AsBits,
64			AsMutBits,
65			BitView as _,
66			BitViewSized as _,
67		},
68		BitArr,
69	};
70	#[cfg(feature = "alloc")]
71	pub use crate::{
72		bitbox,
73		bitvec,
74		boxed::BitBox,
75		vec::BitVec,
76	};
77}