Struct enum_map::EnumMap [] [src]

pub struct EnumMap<K: Internal<V>, V> { /* fields omitted */ }

An enum mapping.

This internally uses an array which stores a value for each possible enum value. To work, it requires implementation of internal (private, although public due to macro limitations) trait which allows extracting information about an enum, which can be automatically generated using #[derive(EnumMap)] macro.

Additionally, bool and u8 automatically derives from EnumMap. While u8 is not technically an enum, it's convenient to consider it like one. In particular, reverse-complement in benchmark game could be using u8 as an enum.

Examples

#[macro_use]
extern crate enum_map;

use enum_map::EnumMap;

#[derive(EnumMap)]
enum Example {
    A,
    B,
    C,
}

fn main() {
    let mut map = EnumMap::new();
    // new initializes map with default values
    assert_eq!(map[Example::A], 0);
    map[Example::A] = 3;
    assert_eq!(map[Example::A], 3);
}

Methods

impl<K: Internal<V>, V: Default> EnumMap<K, V>
[src]

[src]

Creates an enum map with default values.

Examples

#[macro_use]
extern crate enum_map;

use enum_map::EnumMap;

#[derive(EnumMap)]
enum Example {
    A,
}

fn main() {
    let enum_map = EnumMap::<_, i32>::new();
    assert_eq!(enum_map[Example::A], 0);
}

impl<K: Internal<V>, V> EnumMap<K, V>
[src]

Important traits for Iter<'a, K, V>
[src]

Returns an iterator over enum map.

Important traits for IterMut<'a, K, V>
[src]

Returns a mutable iterator over enum map.

[src]

Returns number of elements in enum map.

[src]

Returns whether the enum variant set is empty.

This isn't particularly useful, as there is no real reason to use enum map for enums without variants. However, it is provided for consistency with data structures providing len method (and I will admit, to avoid clippy warnings).

Examples

#[macro_use]
extern crate enum_map;

use enum_map::EnumMap;

#[derive(EnumMap)]
enum Void {}

#[derive(EnumMap)]
enum SingleVariant {
    Variant,
}

fn main() {
    assert!(EnumMap::<Void, ()>::new().is_empty());
    assert!(!EnumMap::<SingleVariant, ()>::new().is_empty());
}

[src]

Swaps two indexes.

Examples

#[macro_use]
extern crate enum_map;

fn main() {
    let mut map = enum_map! { false => 0, true => 1 };
    map.swap(false, true);
    assert_eq!(map[false], 1);
    assert_eq!(map[true], 0);
}

[src]

An iterator visiting all values. The iterator type is &V.

Examples

#[macro_use]
extern crate enum_map;

fn main() {
    let map = enum_map! { false => 3, true => 4 };
    let mut values = map.values();
    assert_eq!(values.next(), Some(&3));
    assert_eq!(values.next(), Some(&4));
    assert_eq!(values.next(), None);
}

[src]

Converts an enum map to a slice representing values.

[src]

Converts a mutable enum map to a mutable slice representing values.

[src]

An iterator visiting all values mutably. The iterator type is &mut V.

Examples

#[macro_use]
extern crate enum_map;

fn main() {
    let mut map = enum_map! { _ => 2 };
    for value in map.values_mut() {
        *value += 2;
    }
    assert_eq!(map[false], 4);
    assert_eq!(map[true], 4);
}

[src]

Returns a raw pointer to the enum map's buffer.

The caller must ensure that the slice outlives the pointer this function returns, or else it will end up pointing to garbage.

Modifying the container referenced by this slice may cause its buffer to be reallocated, which would also make any pointers to it invalid.

Examples

#[macro_use]
extern crate enum_map;

use enum_map::EnumMap;

fn main() {
    let map = enum_map! { 5 => 42, _ => 0 };
    assert_eq!(unsafe { *map.as_ptr().offset(5) }, 42);
}

[src]

Returns an unsafe mutable pointer to the enum map's buffer.

The caller must ensure that the slice outlives the pointer this function returns, or else it will end up pointing to garbage.

Modifying the container referenced by this slice may cause its buffer to be reallocated, which would also make any pointers to it invalid.

Examples

#[macro_use]
extern crate enum_map;

use enum_map::EnumMap;

fn main() {
    let mut map = enum_map! { _ => 0 };
    unsafe {
        *map.as_mut_ptr().offset(11) = 23
    };
    assert_eq!(map[11], 23);
}

Trait Implementations

impl<K: Internal<V> + Debug, V: Debug> Debug for EnumMap<K, V>
[src]

[src]

Formats the value using the given formatter. Read more

impl<K: Internal<V>, V> Extend<(K, V)> for EnumMap<K, V>
[src]

[src]

Extends a collection with the contents of an iterator. Read more

impl<'a, K, V> Extend<(&'a K, &'a V)> for EnumMap<K, V> where
    K: Internal<V> + Copy,
    V: Copy
[src]

[src]

Extends a collection with the contents of an iterator. Read more

impl<K: Internal<V>, V> Index<K> for EnumMap<K, V>
[src]

The returned type after indexing.

[src]

Performs the indexing (container[index]) operation.

impl<K: Internal<V>, V> IndexMut<K> for EnumMap<K, V>
[src]

[src]

Performs the mutable indexing (container[index]) operation.

impl<K: Internal<V>, V> Clone for EnumMap<K, V> where
    K::Array: Clone
[src]

[src]

Returns a copy of the value. Read more

1.0.0
[src]

Performs copy-assignment from source. Read more

impl<K: Internal<V>, V> Copy for EnumMap<K, V> where
    K::Array: Copy
[src]

impl<K: Internal<V>, V: PartialEq> PartialEq for EnumMap<K, V>
[src]

[src]

This method tests for self and other values to be equal, and is used by ==. Read more

1.0.0
[src]

This method tests for !=.

impl<K: Internal<V>, V: Eq> Eq for EnumMap<K, V>
[src]

impl<K: Internal<V>, V: Hash> Hash for EnumMap<K, V>
[src]

[src]

Feeds this value into the given [Hasher]. Read more

1.3.0
[src]

Feeds a slice of this type into the given [Hasher]. Read more

impl<K: Internal<V>, V: Default> Default for EnumMap<K, V>
[src]

[src]

Returns the "default value" for a type. Read more

impl<'a, K: Internal<V>, V> IntoIterator for &'a EnumMap<K, V>
[src]

The type of the elements being iterated over.

Which kind of iterator are we turning this into?

[src]

Creates an iterator from a value. Read more

impl<'a, K: Internal<V>, V> IntoIterator for &'a mut EnumMap<K, V>
[src]

The type of the elements being iterated over.

Which kind of iterator are we turning this into?

[src]

Creates an iterator from a value. Read more

impl<K: Internal<V>, V> IntoIterator for EnumMap<K, V>
[src]

The type of the elements being iterated over.

Which kind of iterator are we turning this into?

[src]

Creates an iterator from a value. Read more

impl<K: Internal<V> + Serialize, V: Serialize> Serialize for EnumMap<K, V>
[src]

Requires crate feature "serde"

[src]

Serialize this value into the given Serde serializer. Read more

impl<'de, K, V> Deserialize<'de> for EnumMap<K, V> where
    K: Internal<V> + Internal<Option<V>> + Deserialize<'de>,
    V: Deserialize<'de>, 
[src]

Requires crate feature "serde"

[src]

Deserialize this value from the given Serde deserializer. Read more

impl<F: FnMut(K) -> V, K: Internal<V>, V> From<F> for EnumMap<K, V>
[src]

[src]

Performs the conversion.

Auto Trait Implementations

impl<K, V> Send for EnumMap<K, V> where
    <K as Internal<V>>::Array: Send

impl<K, V> Sync for EnumMap<K, V> where
    <K as Internal<V>>::Array: Sync