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
29
30
31
32
33
34
35
36
37
38
39
40

# Exclusive Bit-Slice Splitting

This iterator yields `n` successive non-overlapping mutable segments of a
bit-slice, separated by bits that match a predicate function. Splitting advances
one segment at a time, starting at the beginning of the bit-slice.

The matched bit is **not** included in the yielded segment. The `n`th yielded
segment does not attempt any further splits, and extends to the end of the
bit-slice.

It is created by the [`BitSlice::splitn_mut`] method.

## Original

[`slice::SplitNMut`](core::slice::SplitNMut)

## API Differences

This iterator marks all yielded bit-slices as `::Alias`ed.

The predicate function receives both the index within the bit-slice, as well as
the bit value, in order to allow the predicate to have more than one bit of
information when splitting.

## Examples

```rust
use bitvec::prelude::*;

let bits = bits![mut 0, 0, 0, 1, 1, 1, 0, 1];
let mut split = bits.splitn_mut(2, |idx, _bit| idx % 3 == 2);

split.next().unwrap().fill(true);
split.next().unwrap().fill(false);
assert!(split.next().is_none());

assert_eq!(bits, bits![1, 1, 0, 0, 0, 0, 0, 0]);
```

[`BitSlice::splitn_mut`]: crate::slice::BitSlice::splitn_mut