[go: up one dir, main page]

bitfrob/
lib.rs

1#![no_std]
2#![warn(missing_docs)]
3#![forbid(unsafe_code)]
4#![allow(clippy::identity_op)]
5#![cfg_attr(test, allow(bad_style))]
6#![warn(clippy::missing_panics_doc)]
7#![warn(clippy::must_use_candidate)]
8#![warn(missing_copy_implementations)]
9#![warn(clippy::missing_const_for_fn)]
10#![warn(missing_debug_implementations)]
11#![warn(clippy::missing_inline_in_public_items)]
12
13//! A crate to help with bit manipulation of integers.
14//!
15//! ## Features
16//! * `track_caller` adds the [`#[track_caller]`][ref-track_caller] attribute on
17//!   all the functions that assert stuff.
18//!
19//! [ref-track_caller]:
20//!     https://doc.rust-lang.org/reference/attributes/codegen.html#the-track_caller-attribute
21
22mod bit_iter_high;
23mod bit_iter_low;
24mod bit_split;
25mod get_bit;
26mod get_region;
27mod get_value;
28mod region_mask;
29mod replicate_bits;
30mod u8x2_;
31mod with_bit;
32mod with_region;
33mod with_value;
34
35pub use self::{
36  bit_iter_high::*, bit_iter_low::*, bit_split::*, get_bit::*, get_region::*,
37  get_value::*, region_mask::*, replicate_bits::*, u8x2_::*, with_bit::*,
38  with_region::*, with_value::*,
39};