Trait collect_slice::CollectSlice [−] [src]

pub trait CollectSlice: Iterator {
    fn collect_slice(&mut self, slice: &mut [Self::Item]) -> usize;

    fn collect_slice_fill(&mut self, slice: &mut [Self::Item]) { ... }
    fn collect_slice_exhaust(&mut self, slice: &mut [Self::Item]) -> usize { ... }
    fn collect_slice_checked(&mut self, slice: &mut [Self::Item]) { ... }
}

An iterator that can collect into a slice.

Required Methods

Loop through the iterator, sequentially writing items into the given slice until either the iterator runs out of items or the slice fills up.

Return the number of items written.

Examples

use collect_slice::CollectSlice;

let mut buf = [0; 10];

// Fill a whole slice.
let count = (0..10).collect_slice(&mut buf[..]);
assert_eq!(count, 10);
assert_eq!(buf, [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]);

// Write into a subslice
let count = (10..20).collect_slice(&mut buf[5..7]);
assert_eq!(count, 2);
assert_eq!(buf, [0, 1, 2, 3, 4, 10, 11, 7, 8, 9]);

// Only writes until iterator is exhausted.
let count = (8..10).collect_slice(&mut buf[..]);
assert_eq!(count, 2);
assert_eq!(buf, [8, 9, 2, 3, 4, 10, 11, 7, 8, 9]);

// Extra iterator items are ignored.
let count = (20..40).collect_slice(&mut buf[..]);
assert_eq!(count, 10);
assert_eq!(buf, [20, 21, 22, 23, 24, 25, 26, 27, 28, 29]);

Provided Methods

Perform collect_slice() and panic if iterator yielded too few items to fill the slice.

If this function succeeds, the number of items written equals the size of the given slice.

Examples

use collect_slice::CollectSlice;

let mut buf = [0; 10];

// Succeeds as long as entire slice is filled.
(0..20).collect_slice_fill(&mut buf[..]);
(0..5).collect_slice_fill(&mut buf[..5]);

// Panics otherwise!
(0..5).collect_slice_fill(&mut buf[..]);

Perform collect_slice() and panic if the slice was too small to hold all the items.

Return the number of items written.

Examples

use collect_slice::CollectSlice;

let mut buf = [0; 10];

// Succeeds as long as iterator yields all its items.
let count = (0..10).collect_slice_exhaust(&mut buf[..]);
assert_eq!(count, 10);
let count = (0..5).collect_slice_exhaust(&mut buf[..]);
assert_eq!(count, 5);

// Panics otherwise!
(0..20).collect_slice_exhaust(&mut buf[..]);

Perform collect_slice() and panic if there weren't enough items to fill up the slice or the slice was too small to hold all the items.

If this function succeeds, the number of items written equals the size of the given slice.

Examples

use collect_slice::CollectSlice;

// Succeeds as long as iteration count equals slice capacity.
let mut buf = [0; 10];
(0..10).collect_slice_checked(&mut buf[..]);
(0..5).collect_slice_checked(&mut buf[2..7]);
use collect_slice::CollectSlice;

// Panics if iterator isn't exhausted!
let mut buf = [0; 10];
(0..20).collect_slice_checked(&mut buf[..]);
use collect_slice::CollectSlice;

// Panics if slice isn't filled!
let mut buf = [0; 10];
(0..5).collect_slice_checked(&mut buf[..]);

Implementors