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

# Shared Bit-Slice Reverse Splitting

This iterator yields `n` successive non-overlapping segments of a bit-slice,
separated by bits that match a predicate function. Splitting advances one
segment at a time, starting at the end 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 front of the
bit-slice.

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

## Original

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

## API Differences

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![0, 0, 0, 1, 1, 1, 0, 1];
let mut split = bits.rsplitn(2, |idx, _bit| idx % 3 == 2);

assert_eq!(split.next().unwrap(), bits![0, 1]);
assert_eq!(split.next().unwrap(), bits![0, 0, 0, 1, 1]);
assert!(split.next().is_none());
```

[`BitSlice::rsplitn`]: crate::slice::BitSlice::rsplitn