Struct surge_param::ValTypeArray

pub struct ValTypeArray<T> { /* private fields */ }

Container to associate each enum variant with a datum.

This is an array type and it implements much of the array API, with a few caveats and exceptions. The foremost deviation from the standard array API is that this container must be indexed using variants of the correct enum type.

Implementations

impl<T> ValTypeArray<T>

pub fn new(initial_value: T) -> Self where
    T: Clone, 

Create a new array filled with the given value.

pub fn new_with<F>(initial_value: F) -> Self where
    F: Fn(ValType) -> T, 

Create a new array using a closure to associate each enum variant with its initial value.

pub const fn len(&self) -> usize

pub const fn is_empty(&self) -> bool

pub fn iter<'a>(&'a self) -> impl Iterator<Item = &T>

pub fn iter_mut<'a>(&'a mut self) -> impl Iterator<Item = &mut T>

pub fn iter_enumerate<'a>(&'a self) -> impl Iterator<Item = (ValType, &T)>

Iterate and Enumerate, where Enumerate yields enum variants instead of usize.

pub fn iter_mut_enumerate<'a>(
    &'a mut self
) -> impl Iterator<Item = (ValType, &mut T)>

Iterate and Enumerate, where Enumerate yields enum variants instead of usize.

pub fn map<F, Q>(&self, f: F) -> ValTypeArray<Q> where
    F: Fn(&T) -> Q, 

Returns an array like self, with function f applied to each element.

pub fn contains(&self, x: &T) -> bool where
    T: PartialEq<T>, 

Returns true if the array contains an element with the given value.

Trait Implementations

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

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

impl<T> Default for ValTypeArray<T> where
    T: Default, 

fn default() -> Self

Returns the “default value” for a type.

impl<T> Hash for ValTypeArray<T> where
    T: Hash, 

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl<T> Index<ValType> for ValTypeArray<T>

type Output = T

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<T> IndexMut<ValType> for ValTypeArray<T>

fn index_mut(&mut self, x: ValType) -> &mut Self::Output

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

impl<'a, T> IntoIterator for &'a ValTypeArray<T>

type Item = &'a T

The type of the elements being iterated over.

type IntoIter = Iter<'a, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Iter<'a, T>

Creates an iterator from a value.

impl<'a, T> IntoIterator for &'a mut ValTypeArray<T>

type Item = &'a mut T

The type of the elements being iterated over.

type IntoIter = IterMut<'a, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> IterMut<'a, T>

Creates an iterator from a value.

impl<T> Ord for ValTypeArray<T> where
    T: Ord, 

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl<T> PartialEq<ValTypeArray<T>> for ValTypeArray<T> where
    T: PartialEq, 

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

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

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

This method tests for !=.

impl<T> PartialOrd<ValTypeArray<T>> for ValTypeArray<T> where
    T: 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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl<T> Copy for ValTypeArray<T> where
    T: Copy, 

impl<T> Eq for ValTypeArray<T> where
    T: Eq,