bitstring/
lib.rs

1//! This crate provides traits to treat various objects as bit strings.
2//!
3//! ## Features
4//!
5//! - `fixed`: enables [`FixedBitString`] and [`fixed_bit_string`]
6//! - `bigendian`: enables [`utils::BigEndianBitString`] and [`utils::bigendian`]
7//! - `net`: implements [`FixedBitString`] for [`Ipv4Addr`] and [`Ipv6Addr`]
8//!
9//! [`Ipv4Addr`]: core::net::Ipv4Addr
10//! [`Ipv6Addr`]: core::net::Ipv6Addr
11#![warn(missing_docs)]
12#![doc(html_root_url = "https://docs.rs/bitstring/0.2.1")]
13#![no_std]
14#![cfg_attr(docsrs, feature(doc_cfg))]
15
16pub use self::bit_string::BitString;
17
18#[cfg(feature = "fixed")]
19pub use self::{
20	bit_length_string::BitLengthString,
21	fixed_bit_string::traits::FixedBitString,
22};
23
24mod bit_string;
25
26#[cfg(feature = "net")]
27mod address;
28
29pub mod utils;
30
31#[cfg(feature = "fixed")]
32mod bit_length_string;
33#[cfg(feature = "fixed")]
34pub mod fixed_bit_string;