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
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
use crate::{BitBuf, Error, Result, Storage};
impl<S: Storage> BitBuf<S> {
/// Read a BE-bit-order [`u8`] from `byte_offset` without performing bound checks
///
/// # Safety
///
/// * This is UB if [`byte_offset >= self.bytes().len()`][Self::bytes]
///
/// # Panics
///
/// * Panics in debug mode if [`byte_offset >= self.bytes().len()`][Self::bytes]
#[inline(always)]
#[must_use]
pub unsafe fn read_u8_be_aligned_full_at_unchecked(&self, byte_offset: usize) -> u8 {
let bytes = self.bytes();
debug_assert!(
byte_offset < bytes.len(),
"BitBuf::read_u8_be_aligned_full_at_unchecked: index out of bounds! len is {}, offset is {}",
bytes.len(),
byte_offset,
);
unsafe { *bytes.get_unchecked(byte_offset) }
}
/// Read the next BE-bit-order [`u8`] without performing bound checks, advancing the internal cursor
///
/// # Safety
///
/// * The internal cursor must be byte-aligned ([`self.is_aligned()`][Self::is_aligned])
/// * This is UB if the internal cursor points past the end of storage (<code>[self.byte_pos()][Self::byte_pos] >= [self.bytes().len()][Self::bytes]</code>)
///
/// # Panics
///
/// * Panics in debug mode if the internal cursor is not byte-aligned ([`!self.is_aligned()`][Self::is_aligned])
/// * Panics in debug mode if the internal cursor points past the end of storage (<code>[self.byte_pos()][Self::byte_pos] >= [self.bytes().len()][Self::bytes]</code>)
#[inline(always)]
#[must_use]
pub unsafe fn read_u8_be_aligned_full_unchecked(&mut self) -> u8 {
debug_assert!(
self.is_aligned(),
"BitBuf::read_u8_be_aligned_full_unchecked called at unaligned bit position: {}",
self.pos(),
);
let b = unsafe { self.read_u8_be_aligned_full_at_unchecked(self.byte_pos()) };
self.advance_bytes(1);
b
}
/// Read a BE-bit-order [`u8`] from `offset` without performing bound checks
///
/// # Safety
///
/// * This is UB if <code>(offset / 8) >= [`self.bytes().len()`][Self::bytes]</code>
/// * This is UB if <code>(offset % 8 != 0) && (offset / 8) + 1 >= [`self.bytes().len()`][Self::bytes]</code>
///
/// # Panics
///
/// * Panics in debug mode if <code>(offset / 8) >= [`self.bytes().len()`][Self::bytes]</code>
/// * Panics in debug mode if <code>(offset % 8 != 0) && (offset / 8) + 1 >= [`self.bytes().len()`][Self::bytes]</code>
#[inline(always)]
#[must_use]
pub unsafe fn read_u8_be_full_at_unchecked(&self, offset: usize) -> u8 {
let byte_idx = offset / 8;
let shift = offset % 8;
let bytes = self.bytes();
debug_assert!(
byte_idx < bytes.len(),
"BitBuf::read_u8_be_full_at_unchecked: index out of bounds! len is {}, byte_idx is {}",
bytes.len(),
byte_idx,
);
if shift == 0 {
unsafe { self.read_u8_be_aligned_full_at_unchecked(byte_idx) }
} else {
let next_idx = byte_idx + 1;
debug_assert!(
next_idx < bytes.len(),
"BitBuf::read_u8_be_full_at_unchecked: lookahead index out of bounds! len is {}, lookahead byte_idx is {}",
bytes.len(),
next_idx,
);
let (high, low) = unsafe {
(
*bytes.get_unchecked(byte_idx),
*bytes.get_unchecked(next_idx),
)
};
(high << shift) | (low >> (8 - shift))
}
}
/// Read a BE-bit-order [`u8`] from `offset` while performing bound checks
///
/// # Errors
///
/// * Returns [`Error::OutOfBounds`]
/// * if <code>(offset / 8) >= [`self.bytes().len()`][Self::bytes]</code>
/// * if <code>(offset % 8 != 0) && (offset / 8) + 1 >= [`self.bytes().len()`][Self::bytes]</code>
#[inline(always)]
pub fn try_read_u8_be_full_at(&self, offset: usize) -> Result<u8> {
let byte_idx = offset / 8;
let shift = offset % 8;
let len = self.bytes().len();
if byte_idx >= len {
return Err(Error::OutOfBounds);
}
if shift != 0 && byte_idx + 1 >= len {
return Err(Error::OutOfBounds);
}
Ok(unsafe { self.read_u8_be_full_at_unchecked(offset) })
}
/// Read a BE-bit-order [`u8`] from `offset`, panicking on out of bounds
///
/// # Panics
///
/// * Panics if <code>(offset / 8) >= [`self.bytes().len()`][Self::bytes]</code>
/// * Panics if <code>(offset % 8 != 0) && (offset / 8) + 1 >= [`self.bytes().len()`][Self::bytes]</code>
#[inline(always)]
#[must_use]
pub fn read_u8_be_full_at(&self, offset: usize) -> u8 {
self
.try_read_u8_be_full_at(offset)
.expect("BitBuf::read_u8_be_full_at out of bounds")
}
/// Read a [BE-bit, BE-byte] order [`u16`] from `byte_offset` without performing bound checks
///
/// # Safety
///
/// * This is UB if [`byte_offset + 1 >= self.bytes().len()`][Self::bytes]
///
/// # Panics
///
/// * Panics in debug mode if [`byte_offset + 1 >= self.bytes().len()`][Self::bytes]
#[inline(always)]
#[must_use]
pub unsafe fn read_u16_be_aligned_full_at_unchecked(&self, byte_offset: usize) -> u16 {
let bytes = self.bytes();
debug_assert!(
byte_offset + 1 < bytes.len(),
"BitBuf::read_u16_be_aligned_full_at_unchecked: index out of bounds! len is {}, offset is {}",
bytes.len(),
byte_offset + 1,
);
unsafe {
let high = *bytes.get_unchecked(byte_offset);
let low = *bytes.get_unchecked(byte_offset + 1);
u16::from_be_bytes([high, low])
}
}
/// Read the next [BE-bit, BE-byte] order [`u16`] without performing bound checks, advancing the internal cursor
///
/// # Safety
///
/// * The internal cursor must be byte-aligned ([`self.is_aligned()`][Self::is_aligned])
/// * This is UB if the internal cursor points past the end of storage (<code>[self.byte_pos()][Self::byte_pos] + 1 >= [self.bytes().len()][Self::bytes]</code>)
///
/// # Panics
///
/// * Panics in debug mode if the internal cursor is not byte-aligned ([`!self.is_aligned()`][Self::is_aligned])
/// * Panics in debug mode if the internal cursor points past the end of storage (<code>[self.byte_pos()][Self::byte_pos] + 1 >= [self.bytes().len()][Self::bytes]</code>)
#[inline(always)]
#[must_use]
pub unsafe fn read_u16_be_aligned_full_unchecked(&mut self) -> u16 {
debug_assert!(
self.is_aligned(),
"BitBuf::read_u16_be_aligned_full_unchecked called at unaligned bit position: {}",
self.pos(),
);
let v = unsafe { self.read_u16_be_aligned_full_at_unchecked(self.byte_pos()) };
self.advance_bytes(2);
v
}
}