Struct surge_modulation::imports::PoleTypeArray

pub struct PoleTypeArray<T> { /* fields omitted */ }

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> PoleTypeArray<T>

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

Create a new array filled with the given value.

pub fn new_with<F>(initial_value: F) -> PoleTypeArray<T> where
    F: Fn(PoleType) -> 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 self) -> impl Iterator<Item = &'a T>

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

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

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

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

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

pub fn map<F, Q>(&self, f: F) -> PoleTypeArray<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 PoleTypeArray<T> where
    T: Clone, 

pub fn clone(&self) -> PoleTypeArray<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

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

pub fn default() -> PoleTypeArray<T>

Returns the “default value” for a type.

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

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

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<PoleType> for PoleTypeArray<T>

type Output = T

The returned type after indexing.

pub fn index(
    &self,
    x: PoleType
) -> &<PoleTypeArray<T> as Index<PoleType>>::Output

Performs the indexing (container[index]) operation.

impl<T> IndexMut<PoleType> for PoleTypeArray<T>

pub fn index_mut(
    &mut self,
    x: PoleType
) -> &mut <PoleTypeArray<T> as Index<PoleType>>::Output

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

impl<'a, T> IntoIterator for &'a mut PoleTypeArray<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?

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

Creates an iterator from a value.

impl<'a, T> IntoIterator for &'a PoleTypeArray<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?

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

Creates an iterator from a value.

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

pub fn cmp(&self, other: &PoleTypeArray<T>) -> 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<PoleTypeArray<T>> for PoleTypeArray<T> where
    T: PartialEq<T>, 

pub fn eq(&self, other: &PoleTypeArray<T>) -> 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<PoleTypeArray<T>> for PoleTypeArray<T> where
    T: PartialOrd<T>, 

pub fn partial_cmp(&self, other: &PoleTypeArray<T>) -> 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 PoleTypeArray<T> where
    T: Copy, 

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