Struct ArrayMap 

pub struct ArrayMap<K: ArrayFinite<V>, V>(/* private fields */);

A complete mapping from keys of type K to values of type V, implemented using an array indexed by Finite::index_of of the key.

Example

use cantor::{Finite, ArrayMap};

// Define key type
#[derive(Finite, PartialEq, Eq, PartialOrd, Ord, Clone, Copy, Debug)]
enum MyType {
    A,
    B(bool),
    C(bool, bool)
};

// Initialize map
let mut map = ArrayMap::new(|x: MyType| match x {
    MyType::A => false,
    MyType::B(a) => a,
    MyType::C(a, _) => a,
});

// Use map
map[MyType::C(true, true)] = false;
assert_eq!(map[MyType::A], false);
assert_eq!(map[MyType::B(true)], true);
assert_eq!(map[MyType::C(true, true)], false);

Implementations

impl<K: ArrayFinite<V>, V> ArrayMap<K, V>

pub fn new(f: impl FnMut(K) -> V) -> Self

Constructs a new ArrayMap with initial values populated using the given function.

pub fn from(array: K::Array) -> Self

Constructs a new ArrayMap from an array of values, each corresponding to the key determined by Finite::nth.

Example

use cantor::*;
let map = ArrayMap::from([1, 3]);
assert_eq!(map[false], 1);
assert_eq!(map[true], 3);

pub fn map_with_key<N>(&self, f: impl FnMut(K, &V) -> N) -> ArrayMap<K, N>

where K: ArrayFinite<N>,

Applies a mapping function the values of this map.

pub fn map<N>(&self, f: impl FnMut(&V) -> N) -> ArrayMap<K, N>

where K: ArrayFinite<N>,

Applies a mapping function the values of this map.

Trait Implementations

impl<K: ArrayFinite<V>, V> Clone for ArrayMap<K, V>

where K::Array: Clone,

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<K: ArrayFinite<V>, V: Default> Default for ArrayMap<K, V>

fn default() -> Self

Returns the “default value” for a type.

impl<K: CompressFinite + ArrayFinite<V>, V> Index<Compress<K>> for ArrayMap<K, V>

type Output = V

The returned type after indexing.

fn index(&self, index: Compress<K>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<K: ArrayFinite<V>, V> Index<K> for ArrayMap<K, V>

type Output = V

The returned type after indexing.

fn index(&self, index: K) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<K: CompressFinite + ArrayFinite<V>, V> IndexMut<Compress<K>> for ArrayMap<K, V>

fn index_mut(&mut self, index: Compress<K>) -> &mut Self::Output

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

impl<K: ArrayFinite<V>, V> IndexMut<K> for ArrayMap<K, V>

fn index_mut(&mut self, index: K) -> &mut Self::Output

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

impl<K: ArrayFinite<V>, V> Ord for ArrayMap<K, V>

where K::Array: Ord,

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<K: ArrayFinite<V>, V> PartialEq for ArrayMap<K, V>

where K::Array: PartialEq,

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<K: ArrayFinite<V>, V> PartialOrd for ArrayMap<K, V>

where K::Array: PartialOrd,

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<K: ArrayFinite<V>, V> Copy for ArrayMap<K, V>

where K::Array: Copy,

impl<K: ArrayFinite<V>, V> Eq for ArrayMap<K, V>

where K::Array: Eq,