#enums #variant #iterator #cardinality #enumerate

enum-iterator

Tools to iterate over all values of a type (e.g. all variants of an enumeration)

24 releases (13 stable)

2.1.0 May 1, 2024
2.0.0 Feb 25, 2024
1.5.0 Jan 15, 2024
1.4.1 May 4, 2023
0.2.0 Jul 2, 2018

#32 in Rust patterns

Download history 158174/week @ 2024-08-15 172194/week @ 2024-08-22 151817/week @ 2024-08-29 163387/week @ 2024-09-05 135127/week @ 2024-09-12 143031/week @ 2024-09-19 167798/week @ 2024-09-26 154132/week @ 2024-10-03 162017/week @ 2024-10-10 167515/week @ 2024-10-17 161355/week @ 2024-10-24 158294/week @ 2024-10-31 150523/week @ 2024-11-07 230710/week @ 2024-11-14 146507/week @ 2024-11-21 122306/week @ 2024-11-28

679,539 downloads per month
Used in 1,412 crates (161 directly)

0BSD license

34KB
628 lines

Overview

Tools to iterate over the values of a type.

Examples

use enum_iterator::{all, cardinality, first, last, next, previous, reverse_all, Sequence};

#[derive(Debug, PartialEq, Sequence)]
enum Day { Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday }

assert_eq!(cardinality::<Day>(), 7);
assert_eq!(all::<Day>().collect::<Vec<_>>(), [
    Day::Monday,
    Day::Tuesday,
    Day::Wednesday,
    Day::Thursday,
    Day::Friday,
    Day::Saturday,
    Day::Sunday,
]);
assert_eq!(first::<Day>(), Some(Day::Monday));
assert_eq!(last::<Day>(), Some(Day::Sunday));
assert_eq!(next(&Day::Tuesday), Some(Day::Wednesday));
assert_eq!(previous(&Day::Wednesday), Some(Day::Tuesday));
assert_eq!(reverse_all::<Day>().collect::<Vec<_>>(), [
    Day::Sunday,
    Day::Saturday,
    Day::Friday,
    Day::Thursday,
    Day::Wednesday,
    Day::Tuesday,
    Day::Monday,
]);
use enum_iterator::{cardinality, first, last, Sequence};

#[derive(Debug, PartialEq, Sequence)]
struct Foo {
    a: bool,
    b: u8,
}

assert_eq!(cardinality::<Foo>(), 512);
assert_eq!(first::<Foo>(), Some(Foo { a: false, b: 0 }));
assert_eq!(last::<Foo>(), Some(Foo { a: true, b: 255 }));

Rust version

This crate tracks stable Rust. Minor releases may require a newer Rust version. Patch releases must not require a newer Rust version.

Contribute

All contributions shall be licensed under the 0BSD license.

Dependencies

~250–700KB
~17K SLoC