bitvec 1.0.1

Addresses memory by bits, for packed collections and bitfields
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

# Single-Bit Read

This reads the bit out of `src` directly.

## Original

[`ptr::read`](core::ptr::read)

## Safety

Because this performs a dereference of memory, it inherits the original
`ptr::read`’s requirements:

- `src` must be valid to read.
- `src` must be properly aligned. This is an invariant of the `BitPtr` type as
  well as of the memory access.
- `src` must point to an initialized value of `T`.

## Examples

```rust
use bitvec::prelude::*;
use bitvec::ptr as bv_ptr;

let data = 128u8;
let ptr = BitPtr::<_, _, Msb0>::from_ref(&data);
assert!(unsafe { bv_ptr::read(ptr) });
```