Struct otter_api_tests::EnumMap[−]

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

Expand description

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(Enum)] macro.

Additionally, bool and u8 automatically derives from Enum. 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

use enum_map::{enum_map, Enum, EnumMap};

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

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

Implementations

impl<K, V> EnumMap<K, V> where
    K: Enum<V>,

pub fn values(&self) -> Values<'_, V>ⓘNotable traits for Values<'a, V>
impl<'a, V> Iterator for Values<'a, V> where
    V: 'a,     type Item = &'a V;

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

Examples

use enum_map::enum_map;

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);

pub fn values_mut(&mut self) -> ValuesMut<'_, V>ⓘNotable traits for ValuesMut<'a, V>
impl<'a, V> Iterator for ValuesMut<'a, V> where
    V: 'a,     type Item = &'a mut V;

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

Examples

use enum_map::enum_map;

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

impl<K, V> EnumMap<K, V> where
    K: Enum<V>,
    V: Default,

pub fn clear(&mut self)

Clear enum map with default values.

Examples

use enum_map::{Enum, EnumMap};

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

let mut enum_map = EnumMap::<_, String>::default();
enum_map[Example::B] = "foo".into();
enum_map.clear();
assert_eq!(enum_map[Example::A], "");
assert_eq!(enum_map[Example::B], "");

impl<K, V> EnumMap<K, V> where
    K: Enum<V>,

pub fn from_array(array: <K as Enum<V>>::Array) -> EnumMap<K, V>

Creates an enum map from array.

pub fn iter(&self) -> Iter<'_, K, V>ⓘNotable traits for Iter<'a, K, V>
impl<'a, K, V> Iterator for Iter<'a, K, V> where
    K: Enum<V>,     type Item = (K, &'a V);

Returns an iterator over enum map.

pub fn iter_mut(&mut self) -> IterMut<'_, K, V>ⓘNotable traits for IterMut<'a, K, V>
impl<'a, K, V> Iterator for IterMut<'a, K, V> where
    K: Enum<V>,     type Item = (K, &'a mut V);

Returns a mutable iterator over enum map.

pub fn len(&self) -> usize

Returns number of elements in enum map.

pub fn swap(&mut self, a: K, b: K)

Swaps two indexes.

Examples

use enum_map::enum_map;

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

pub fn as_slice(&self) -> &[V]ⓘNotable traits for &'_ [u8]
impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]

Converts an enum map to a slice representing values.

pub fn as_mut_slice(&mut self) -> &mut [V]ⓘNotable traits for &'_ [u8]
impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]

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

Trait Implementations

impl<K, V> Clone for EnumMap<K, V> where
    K: Enum<V>,
    <K as Enum<V>>::Array: Clone,

pub fn clone(&self) -> EnumMap<K, V>

Returns a copy of the value. Read more

fn clone_from(&mut self, source: &Self)1.0.0 [src]

Performs copy-assignment from source. Read more

impl<K, V> Debug for EnumMap<K, V> where
    K: Enum<V> + Debug,
    V: Debug,

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter. Read more

impl<K, V> Default for EnumMap<K, V> where
    K: Enum<V>,
    V: Default,

pub fn default() -> EnumMap<K, V>

Returns the “default value” for a type. Read more

impl<'de, K, V> Deserialize<'de> for EnumMap<K, V> where
    K: Enum<V> + Enum<Option<V>> + Deserialize<'de>,
    V: Deserialize<'de>,

Requires crate feature "serde"

pub fn deserialize<D>(
    deserializer: D
) -> Result<EnumMap<K, V>, <D as Deserializer<'de>>::Error> where
    D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

impl<'a, K, V> Extend<(&'a K, &'a V)> for EnumMap<K, V> where
    K: Enum<V> + Copy,
    V: Copy,

pub fn extend<I>(&mut self, iter: I) where
    I: IntoIterator<Item = (&'a K, &'a V)>,

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

fn extend_one(&mut self, item: A)[src]

🔬 This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)[src]

🔬 This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements. Read more

impl<K, V> Extend<(K, V)> for EnumMap<K, V> where
    K: Enum<V>,

pub fn extend<I>(&mut self, iter: I) where
    I: IntoIterator<Item = (K, V)>,

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

fn extend_one(&mut self, item: A)[src]

🔬 This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)[src]

🔬 This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements. Read more

impl<K, V> Hash for EnumMap<K, V> where
    K: Enum<V>,
    V: Hash,

pub fn hash<H>(&self, state: &mut H) where
    H: Hasher,

Feeds this value into the given Hasher. Read more

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher,

1.3.0 [src]

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

impl<K, V> Index<K> for EnumMap<K, V> where
    K: Enum<V>,

type Output = V

The returned type after indexing.

pub fn index(&self, key: K) -> &V

Performs the indexing (container[index]) operation. Read more

impl<K, V> IndexMut<K> for EnumMap<K, V> where
    K: Enum<V>,

pub fn index_mut(&mut self, key: K) -> &mut V

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

impl<'a, K, V> IntoIterator for &'a mut EnumMap<K, V> where
    K: Enum<V>,

type Item = (K, &'a mut V)

The type of the elements being iterated over.

type IntoIter = IterMut<'a, K, V>

Which kind of iterator are we turning this into?

pub fn into_iter(self) -> <&'a mut EnumMap<K, V> as IntoIterator>::IntoIter

Creates an iterator from a value. Read more

impl<'a, K, V> IntoIterator for &'a EnumMap<K, V> where
    K: Enum<V>,

type Item = (K, &'a V)

The type of the elements being iterated over.

type IntoIter = Iter<'a, K, V>

Which kind of iterator are we turning this into?

pub fn into_iter(self) -> <&'a EnumMap<K, V> as IntoIterator>::IntoIter

Creates an iterator from a value. Read more

impl<K, V> IntoIterator for EnumMap<K, V> where
    K: Enum<V>,

type Item = (K, V)

The type of the elements being iterated over.

type IntoIter = IntoIter<K, V>

Which kind of iterator are we turning this into?

pub fn into_iter(self) -> <EnumMap<K, V> as IntoIterator>::IntoIter

Creates an iterator from a value. Read more

impl<K, V> PartialEq<EnumMap<K, V>> for EnumMap<K, V> where
    K: Enum<V>,
    V: PartialEq<V>,

pub fn eq(&self, other: &EnumMap<K, V>) -> bool

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

#[must_use]
fn ne(&self, other: &Rhs) -> bool

1.0.0 [src]

This method tests for !=.

impl<K, V> Serialize for EnumMap<K, V> where
    K: Enum<V> + Serialize,
    V: Serialize,

Requires crate feature "serde"

pub fn serialize<S>(
    &self, 
    serializer: S
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error> where
    S: Serializer,

Serialize this value into the given Serde serializer. Read more

impl<K, V> Copy for EnumMap<K, V> where
    K: Enum<V>,
    <K as Enum<V>>::Array: Copy,

impl<K, V> Eq for EnumMap<K, V> where
    K: Enum<V>,
    V: Eq,

Auto Trait Implementations

impl<K, V> RefUnwindSafe for EnumMap<K, V> where
    <K as Enum<V>>::Array: RefUnwindSafe,

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

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

impl<K, V> Unpin for EnumMap<K, V> where
    <K as Enum<V>>::Array: Unpin,

impl<K, V> UnwindSafe for EnumMap<K, V> where
    <K as Enum<V>>::Array: UnwindSafe,

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized,

[src]

pub fn type_id(&self) -> TypeId[src]

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
    T: ?Sized,

[src]

pub fn borrow(&self) -> &T[src]

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
    T: ?Sized,

[src]

pub fn borrow_mut(&mut self) -> &mut T[src]

Mutably borrows from an owned value. Read more

impl<T> DebugExt<T> for T where
    T: Debug,

pub fn to_debug(&self) -> String

impl<T> Downcast for T where
    T: Any,

pub fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>ⓘNotable traits for Box<R, Global>
impl<R> Read for Box<R, Global> where
    R: Read + ?Sized, impl<W> Write for Box<W, Global> where
    W: Write + ?Sized, impl<I, A> Iterator for Box<I, A> where
    A: Allocator,
    I: Iterator + ?Sized,     type Item = <I as Iterator>::Item;impl<F, A> Future for Box<F, A> where
    A: Allocator + 'static,
    F: Future + Unpin + ?Sized,     type Output = <F as Future>::Output;

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait. Read more

pub fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait. Read more

pub fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s. Read more

pub fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s. Read more

impl<T> DowncastSync for T where
    T: Any + Send + Sync,

pub fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + 'static + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait. Read more

impl<A> DynCastExt for A

pub fn dyn_cast<T>(
    self
) -> Result<<A as DynCastExtHelper<T>>::Target, <A as DynCastExtHelper<T>>::Source> where
    T: ?Sized,
    A: DynCastExtHelper<T>,

Use this to cast from one trait object type to another. Read more

pub fn dyn_upcast<T>(self) -> <A as DynCastExtAdvHelper<T, T>>::Target where
    T: ?Sized,
    A: DynCastExtAdvHelper<T, T, Source = <A as DynCastExtAdvHelper<T, T>>::Target>,

Use this to upcast a trait to one of its supertraits. Read more

pub fn dyn_cast_adv<F, T>(
    self
) -> Result<<A as DynCastExtAdvHelper<F, T>>::Target, <A as DynCastExtAdvHelper<F, T>>::Source> where
    T: ?Sized,
    A: DynCastExtAdvHelper<F, T>,
    F: ?Sized,

Use this to cast from one trait object type to another. This method is more customizable than the dyn_cast method. Here you can also specify the “source” trait from which the cast is defined. This can for example allow using casts from a supertrait of the current trait object. Read more

pub fn dyn_cast_with_config<C>(
    self
) -> Result<<A as DynCastExtAdvHelper<<C as DynCastConfig>::Source, <C as DynCastConfig>::Target>>::Target, <A as DynCastExtAdvHelper<<C as DynCastConfig>::Source, <C as DynCastConfig>::Target>>::Source> where
    C: DynCastConfig,
    A: DynCastExtAdvHelper<<C as DynCastConfig>::Source, <C as DynCastConfig>::Target>,

Use this to cast from one trait object type to another. With this method the type parameter is a config type that uniquely specifies which cast should be preformed. Read more

impl<Q, K> Equivalent<K> for Q where
    K: Borrow<Q> + ?Sized,
    Q: Eq + ?Sized,

[src]

pub fn equivalent(&self, key: &K) -> bool[src]

Compare self to key and return true if they are equal.

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

Performs the conversion.

impl<T> Instrument for T[src]

fn instrument(self, span: Span) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>
impl<T> Future for Instrumented<T> where
    T: Future,     type Output = <T as Future>::Output;

[src]

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>
impl<T> Future for Instrumented<T> where
    T: Future,     type Output = <T as Future>::Output;

[src]

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T where
    U: From<T>,

[src]

pub fn into(self) -> U[src]

Performs the conversion.

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<T> Serialize for T where
    T: Serialize + ?Sized,

[src]

pub fn erased_serialize(
    &self, 
    serializer: &mut dyn Serializer
) -> Result<Ok, Error>

[src]

impl<T> ToOwned for T where
    T: Clone,

[src]

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T[src]

Creates owned data from borrowed data, usually by cloning. Read more

pub fn clone_into(&self, target: &mut T)[src]

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T where
    U: Into<T>,

[src]

type Error = Infallible

The type returned in the event of a conversion error.

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]

Performs the conversion.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>,

[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]

Performs the conversion.

impl<V, T> VZip<V> for T where
    V: MultiLane<T>,

pub fn vzip(self) -> V

impl<T> DeserializeOwned for T where
    T: for<'de> Deserialize<'de>,

[src]

Struct otter_api_tests::EnumMap[−]

Examples

Implementations

Notable traits for Values<'a, V>

Examples

Notable traits for ValuesMut<'a, V>

Examples

Examples

Notable traits for Iter<'a, K, V>

Notable traits for IterMut<'a, K, V>

Examples

Notable traits for &'_ [u8 ]

Notable traits for &'_ [u8 ]

Trait Implementations

Auto Trait Implementations

Blanket Implementations

Notable traits for Box<R, Global>

Notable traits for Instrumented<T>

Notable traits for Instrumented<T>