#iterator #const-generics #chunk #adaptor #iteration #no-alloc

no-std const-chunks

Extension trait to chunk iterators into const-length arrays

6 releases

0.3.0 Oct 4, 2023
0.2.2 Jul 13, 2023
0.2.1 Jun 12, 2023
0.1.1 May 13, 2023

#978 in Rust patterns

MIT/Apache

17KB
177 lines

const-chunks


This crate provides a #![no_std]-compatible extension trait that lets you chunk iterators into constant-length arrays using const generics.

See the docs for more info.

use const_chunks::IteratorConstChunks;

let mut iter = vec![1, 2, 3, 4, 5].into_iter().const_chunks::<2>();
assert_eq!(iter.next(), Some([1,2]));
assert_eq!(iter.next(), Some([3,4]));
assert_eq!(iter.next(), None);

let mut remainder = iter.into_remainder().unwrap();
assert_eq!(remainder.next(), Some(5));
assert_eq!(remainder.next(), None);

Safety

This crate uses unsafe to manipulate uninitialized memory.

To prevent undefined behaviour, the code runs MIRI in CI, and is both very short and easy to audit.

Nevertheless, you should still consider this fact if you're trying to minimize unsafe dependencies.

MSRV

This crate requires rustc version 1.65 or newer.

This crate's MSRV is enforced through the manifest's rust-version key.

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

No runtime deps