bit-buf 0.3.0

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

#![no_std]
#![warn(missing_docs)]

//! See <code>[BitBuf]::[from()][BitBuf::from]</code>, [`Storage`]/[`StorageMut`], and <code>[BitBuf]::{read,write}_*()</code>
//!
//! | Term | Definition |
//! | - | - |
//! | UB | [Undefined Behaviour](https://doc.rust-lang.org/reference/behavior-considered-undefined.html) |
//! | BE | [Big Endian](https://en.wikipedia.org/wiki/Endianness) |
//! | LE | [Little Endian](https://en.wikipedia.org/wiki/Endianness) |
//!
//! Any usage of `pos`/`offset` implies bits rather than bytes

mod buf;
mod error;

mod read;
mod write;

pub use buf::BitBuf;
pub use error::Error;

/// Returned from checked operations
pub type Result<T> = core::result::Result<T, Error>;

/// This trait must be implemented for types from which you wish to use `read_*` operations with
pub trait Storage {
  /// Get the bytes that represent this type
  fn as_bytes(&self) -> &[u8];
}

/// This trait must be implemented for types from which you wish to use `write_*` operations with
pub trait StorageMut: Storage {
  /// Get the bytes that represent this type
  fn as_bytes_mut(&mut self) -> &mut [u8];
}

impl<const N: usize> Storage for [u8; N] {
  #[inline(always)]
  fn as_bytes(&self) -> &[u8] {
    self
  }
}

impl<const N: usize> StorageMut for [u8; N] {
  #[inline(always)]
  fn as_bytes_mut(&mut self) -> &mut [u8] {
    self
  }
}

impl<const N: usize> Storage for &[u8; N] {
  #[inline(always)]
  fn as_bytes(&self) -> &[u8] {
    *self
  }
}

impl<const N: usize> Storage for &mut [u8; N] {
  #[inline(always)]
  fn as_bytes(&self) -> &[u8] {
    *self
  }
}

impl<const N: usize> StorageMut for &mut [u8; N] {
  #[inline(always)]
  fn as_bytes_mut(&mut self) -> &mut [u8] {
    *self
  }
}

impl Storage for &[u8] {
  #[inline(always)]
  fn as_bytes(&self) -> &[u8] {
    self
  }
}

impl Storage for &mut [u8] {
  #[inline(always)]
  fn as_bytes(&self) -> &[u8] {
    self
  }
}

impl StorageMut for &mut [u8] {
  #[inline(always)]
  fn as_bytes_mut(&mut self) -> &mut [u8] {
    self
  }
}

macro_rules! ensure {
  ($cond:expr $(,)? $(; $($tt:tt)*)?) => {
    #[allow(clippy::macro_metavars_in_unsafe)]
    unsafe {
      $(
        #[cfg(test)]
        ::core::assert!($cond, $($tt)*);
      )?

      $(
        #[cfg(not(test))]
        ::core::debug_assert!($cond, $($tt)*);
      )?

      ::core::hint::assert_unchecked($cond);
    }
  };
}

use ensure;