1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
#![doc = include_str!("../doc/array.md")]
use core::marker::PhantomData;
use crate::{
mem,
order::{
BitOrder,
Lsb0,
},
slice::BitSlice,
view::BitViewSized,
};
mod api;
mod iter;
mod ops;
mod tests;
mod traits;
pub use self::iter::IntoIter;
#[repr(transparent)]
#[doc = include_str!("../doc/array/BitArray.md")]
pub struct BitArray<A = [usize; 1], O = Lsb0>
where
A: BitViewSized,
O: BitOrder,
{
/// The ordering of bits within an `A::Store` element.
pub _ord: PhantomData<O>,
/// The wrapped data buffer.
pub data: A,
}
impl<A, O> BitArray<A, O>
where
A: BitViewSized,
O: BitOrder,
{
/// A bit-array with all bits initialized to zero.
pub const ZERO: Self = Self {
_ord: PhantomData,
data: A::ZERO,
};
/// Wraps an existing buffer as a bit-array.
///
/// ## Examples
///
/// ```rust
/// use bitvec::prelude::*;
///
/// let data = [0u16, 1, 2, 3];
/// let bits = BitArray::<_, Msb0>::new(data);
/// assert_eq!(bits.len(), 64);
/// ```
#[inline]
pub fn new(data: A) -> Self {
Self { data, ..Self::ZERO }
}
/// Removes the bit-array wrapper, returning the contained buffer.
///
/// ## Examples
///
/// ```rust
/// use bitvec::prelude::*;
///
/// let bits = bitarr![0; 30];
/// let native: [usize; 1] = bits.into_inner();
/// ```
#[inline]
pub fn into_inner(self) -> A {
self.data
}
/// Explicitly views the bit-array as a bit-slice.
#[inline]
pub fn as_bitslice(&self) -> &BitSlice<A::Store, O> {
self.data.view_bits::<O>()
}
/// Explicitly views the bit-array as a mutable bit-slice.
#[inline]
pub fn as_mut_bitslice(&mut self) -> &mut BitSlice<A::Store, O> {
self.data.view_bits_mut::<O>()
}
/// Views the bit-array as a slice of its underlying memory elements.
#[inline]
pub fn as_raw_slice(&self) -> &[A::Store] {
self.data.as_raw_slice()
}
/// Views the bit-array as a mutable slice of its underlying memory
/// elements.
#[inline]
pub fn as_raw_mut_slice(&mut self) -> &mut [A::Store] {
self.data.as_raw_mut_slice()
}
/// Gets the length (in bits) of the bit-array.
///
/// This method is a compile-time constant.
#[inline]
pub fn len(&self) -> usize {
mem::bits_of::<A>()
}
/// Tests whether the array is empty.
///
/// This method is a compile-time constant.
#[inline]
pub fn is_empty(&self) -> bool {
mem::bits_of::<A>() == 0
}
}