Struct Trigs 

pub struct Trigs<T>(/* private fields */);

Generic collection for data related to trigs. Used in Patterns with parameter lock trig assignments and trig offset/repeat/conditions data.

Box (no-Copy)

Unfortunately serde requires that we wrap the inner array type of Trigs in a Box. As a result, Trigs and any type that contains a Trigs type cannot implement the Copy trait.

Example: Using in your own code with custom inner types

use ot_tools_io::types::Trigs;
use ot_tools_io::Defaults;
use ot_tools_io_derive::{ArrayDefaults, BoxedArrayDefaults};
use std::array::from_fn;

#[derive(Debug, PartialEq, Default, ArrayDefaults, BoxedArrayDefaults)]
pub struct SomeNumber(u8);

fn main() -> Result<(), ()> {
    let mut my_trigs = Trigs::<SomeNumber>::default();
    let first = my_trigs.first_mut().ok_or(())?;
    *first = SomeNumber(100);

    // first one changed
    assert_eq!(my_trigs[0], SomeNumber(100));
    // rest are default
    assert_eq!(my_trigs[1], SomeNumber(0));

    // correct length
    assert_eq!(my_trigs.len(), 64);

    Ok(())
}

Implementations

impl<T> Trigs<T>

pub fn id_ref(&self, id: &TrigId) -> &T

Returns a reference to an element of the array data

Panic-free

This method is panic-free as the id type is guaranteed to never exceed the max index of the underlying array.

pub fn id_mut(&mut self, id: &TrigId) -> &mut T

Returns a mutable reference to an element the array data

Panic-free

This method is panic-free as the id type is guaranteed to never exceed the max index of the underlying array.

impl<T: Copy> Trigs<T>

pub fn id(self, id: &TrigId) -> T

Returns an owned element of the array data

Panic-free

This method is panic-free as the id type is guaranteed to never exceed the max index of the underlying array.

impl<T> Trigs<T>

pub fn unbox(self) -> [T; 64]

Returns an owned [T; 16] by “un-boxing” (dereferencing) the data

pub fn unbox_ref(&self) -> &[T; 64]

Returns a referenced [T; 16] by “un-boxing” (dereferencing) the data

pub fn unbox_mut(&mut self) -> &mut [T; 64]

Returns a mutably referenced [T; 16] by “un-boxing” (dereferencing) the data

impl<T> Trigs<T>

pub fn new(value: [T; 64]) -> Self

pub fn new_boxed(value: Box<[T; 64]>) -> Self

Trait Implementations

impl<T> AsMut<Trigs<T>> for Trigs<T>

fn as_mut(&mut self) -> &mut Trigs<T>

Converts this type into a mutable reference of the (usually inferred) input type.

impl<T> AsRef<Trigs<T>> for Trigs<T>

fn as_ref(&self) -> &Trigs<T>

Converts this type into a shared reference of the (usually inferred) input type.

impl<T: Clone> Clone for Trigs<T>

fn clone(&self) -> Trigs<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Trigs<T>

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

Formats the value using the given formatter.

impl<T: Defaults<Box<[T; 64]>> + Default> Default for Trigs<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T> Deref for Trigs<T>

type Target = [T; 64]

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T> DerefMut for Trigs<T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'de, T: Deserialize<'de>> Deserialize<'de> for Trigs<T>

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: Eq> Eq for Trigs<T>

impl<T: Hash> Hash for Trigs<T>

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T, I> Index<I> for Trigs<T>

where [T]: Index<I>,

type Output = <[T] as Index<I>>::Output

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<T, I> IndexMut<I> for Trigs<T>

where [T]: IndexMut<I>,

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

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

impl<T: Ord> Ord for Trigs<T>

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

fn eq(&self, other: &Trigs<T>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<T: PartialOrd> PartialOrd for Trigs<T>

fn partial_cmp(&self, other: &Trigs<T>) -> 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<T: Serialize> Serialize for Trigs<T>

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: PartialEq> StructuralPartialEq for Trigs<T>