enum-iterator 0.3.1

Tools to iterate over the variants of a field-less enum
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43

// Copyright (C) 2018 Stephane Raux. Distributed under the MIT license.

//! Tools to iterate over the variants of a field-less enum.

#![deny(missing_docs)]
#![deny(warnings)]

pub use enum_iterator_derive::*;

use std::iter;

/// Trait to iterate over the variants of a field-less enum.
///
/// Field-less (a.k.a. C-like) enums are enums whose variants don't have
/// additional data.
///
/// When deriving this trait for an enum named `Foo`, the associated type
/// `Iterator` is a generated type named `FooEnumIterator`. This generated
/// type has the same visibility as `Foo`. Variants are yielded in the order
/// they are defined in the enum. The generated iterator type is `Copy`.
///
/// # Example
///
/// ```
/// use enum_iterator::IntoEnumIterator;
///
/// #[derive(Clone, IntoEnumIterator, PartialEq)]
/// enum Direction {North, South, West, East}
///
/// fn main() {
///     assert!(Direction::into_enum_iter().eq([Direction::North,
///         Direction::South, Direction::West, Direction::East].iter()
///         .cloned()));
/// }
/// ```
pub trait IntoEnumIterator: Sized {
    /// Type of the iterator over the variants.
    type Iterator: Iterator<Item = Self> + iter::ExactSizeIterator
        + iter::FusedIterator;

    /// Returns an iterator over the variants.
    fn into_enum_iter() -> Self::Iterator;
}