Skip to content

An iterator adapter that allows you to efficiently peek the nth item of an iterator.

License

Apache-2.0, MIT licenses found

Licenses found

Apache-2.0
LICENSE-APACHE
MIT
LICENSE-MIT
Notifications You must be signed in to change notification settings

zacharygolba/peek-nth

peek-nth

CircleCI branch AppVeyor branch Crates.io

An iterator adapter that allows you to efficiently peek the nth item of an iterator.

Itermediate values are memoized and heap allocations are avoided when possible.

Installation

First, add peek-nth to the dependencies section of your Cargo.toml:

[dependencies]
peek-nth = "0.2"

Next, add the following snippet to the entry point of your crate (lib.rs or main.rs):

extern crate peek_nth;

Usage

extern crate peek_nth;

use peek_nth::IteratorExt;

fn main() {
    let mut iter = "Hello, world!".chars().peekable_nth();

    assert_eq!(iter.peek_nth(4), Some(&'o')); // Cache Miss
    assert_eq!(iter.peek_nth(3), Some(&'l')); // Cache Hit
    assert_eq!(iter.peek_nth(2), Some(&'l')); // Cache Hit
    assert_eq!(iter.peek_nth(1), Some(&'e')); // Cache Hit
    assert_eq!(iter.peek_nth(0), Some(&'H')); // Cache Hit
    assert_eq!(iter.peek_nth(7), Some(&'w')); // Cache Miss

    assert_eq!(iter.collect::<String>(), "Hello, world!");
}

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.

About

An iterator adapter that allows you to efficiently peek the nth item of an iterator.

Topics

Resources

License

Apache-2.0, MIT licenses found

Licenses found

Apache-2.0
LICENSE-APACHE
MIT
LICENSE-MIT

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages