Notes/notes-service/vendor/bitvec/doc/slice/iter/RSplitMut.md

Exclusive Bit-Slice Reverse Splitting

This iterator yields 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 end of the bit-slice.

The matched bit is not included in the yielded segment.

It is created by the BitSlice::rsplit_mut method.

Original

slice::RSplitMut

API Differences

This iterator marks all yielded bit-slices as ::Aliased.

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

use bitvec::prelude::*;

let bits = bits![mut 0, 0, 0, 1, 1, 1, 0, 1];
let mut split = unsafe {
  bits.rsplit_mut(|idx, _bit| idx % 3 == 2).remove_alias()
};

split.next().unwrap().copy_from_bitslice(bits![1, 0]);
split.next().unwrap().fill(false);
split.next().unwrap().fill(true);
assert!(split.next().is_none());

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