bit-buf 0.1.3

I needed this.
Documentation 
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

use crate::{Storage, StorageMut};

/// The main structure
///
/// Keeps track of the data storage and a cursor for automatic operations
#[derive(Debug)]
pub struct BitBuf<S> {
  data: S,
  cursor: usize,
}

impl<S> BitBuf<S> {
  /// Construct from provided data storage
  pub const fn from(data: S) -> Self {
    Self { data, cursor: 0 }
  }

  /// Get the underlying bytes from the storage
  #[inline(always)]
  pub fn bytes(&self) -> &[u8]
  where
    S: Storage,
  {
    self.data.as_bytes()
  }

  /// Get the underlying bytes from the storage
  #[inline(always)]
  pub fn bytes_mut(&mut self) -> &mut [u8]
  where
    S: StorageMut,
  {
    self.data.as_bytes_mut()
  }

  /// Get the internal cursor for automatic operations
  ///
  /// <div class="warning">
  ///
  /// The cursor may not be within storage bounds
  ///
  /// </div>
  #[inline(always)]
  pub fn pos(&self) -> usize {
    self.cursor
  }

  /// Get the byte-aligned position of the internal cursor for automatic operations
  ///
  /// <div class="warning">
  ///
  /// The cursor may not be within storage bounds
  ///
  /// </div>
  #[inline(always)]
  pub fn byte_pos(&self) -> usize {
    self.cursor / 8
  }

  /// Advance the internal cursor for automatic operations
  ///
  /// <div class="warning">
  ///
  /// This does not enforce that the cursor stay within storage bounds
  ///
  /// </div>
  #[inline(always)]
  pub fn advance(&mut self, bits: usize) -> &mut Self {
    self.cursor += bits;
    self
  }

  /// Advance the internal cursor for automatic operations by a number of bytes
  ///
  /// <div class="warning">
  ///
  /// This does not enforce that the cursor stay within storage bounds
  ///
  /// </div>
  #[inline(always)]
  pub fn advance_bytes(&mut self, bytes: usize) -> &mut Self {
    self.advance(bytes * 8)
  }

  /// Set the internal cursor for automatic operations
  ///
  /// <div class="warning">
  ///
  /// This does not enforce that the cursor stay within storage bounds
  ///
  /// </div>
  #[inline(always)]
  pub fn seek(&mut self, offset: usize) -> &mut Self {
    self.cursor = offset;
    self
  }

  /// Set the internal cursor for automatic operations to a byte position
  ///
  /// This sets the cursor to `offset * 8` bits.
  ///
  /// <div class="warning">
  ///
  /// This does not enforce that the cursor stay within storage bounds
  ///
  /// </div>
  #[inline(always)]
  pub fn seek_byte(&mut self, byte: usize) -> &mut Self {
    self.seek(byte * 8)
  }

  /// Checks if the internal cursor for automatic operations is aligned on the start of a byte
  ///
  /// <div class="warning">
  ///
  /// This does not care whether the cursor is outside storage bounds
  ///
  /// </div>
  #[inline(always)]
  pub fn is_aligned(&self) -> bool {
    self.cursor.is_multiple_of(8)
  }
}