Skip to main content

Tracks

Struct Tracks 

Source
pub struct Tracks<T>(/* private fields */);
Expand description

Generic collection for data related to tracks, e.g. for Recording Buffers, Audio Track Trigs, MIDI Track Trigs and the like. Used by a lot of fields on the Part and Pattern types.

§Copy (no Box)

This generic collection helper does not use Box and can be Copy.

§Example: Using in your own code with custom inner types

use ot_tools_io::types::Tracks;
use ot_tools_io::Defaults;
use ot_tools_io_derive::ArrayDefaults;
use std::array::from_fn;

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

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

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

    // correct length
    assert_eq!(my_tracks.len(), 8);

    Ok(())
}

Implementations§

Source§

impl<T> Tracks<T>

Source

pub fn id_ref(&self, id: &TrackId) -> &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.

Source

pub fn id_mut(&mut self, id: &TrackId) -> &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.

Source§

impl<T: Copy> Tracks<T>

Source

pub fn id(self, id: &TrackId) -> 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.

Source§

impl<T> Tracks<T>

Source

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

Trait Implementations§

Source§

impl<T> AsMut<Tracks<T>> for Tracks<T>

Source§

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

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

impl<T> AsRef<Tracks<T>> for Tracks<T>

Source§

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

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

impl<T: Clone> Clone for Tracks<T>

Source§

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

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T: Copy> Copy for Tracks<T>

Source§

impl<T: Debug> Debug for Tracks<T>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<T: Defaults<[T; 8]> + Default> Default for Tracks<T>

Source§

fn default() -> Self

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

impl<const N: usize, T: Default> Defaults<[Tracks<T>; N]> for Tracks<T>

Source§

fn defaults() -> [Self; N]
where Self: Default,

Create an default container type T containing N default instances of Self.
Source§

impl<T> Deref for Tracks<T>

Source§

type Target = [T; 8]

The resulting type after dereferencing.
Source§

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

Dereferences the value.
Source§

impl<T> DerefMut for Tracks<T>

Source§

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

Mutably dereferences the value.
Source§

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

Source§

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl<T: Eq> Eq for Tracks<T>

Source§

impl<T: Hash> Hash for Tracks<T>

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

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

impl<T, I> Index<I> for Tracks<T>
where [T]: Index<I>,

Source§

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

The returned type after indexing.
Source§

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

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

impl<T, I> IndexMut<I> for Tracks<T>
where [T]: IndexMut<I>,

Source§

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

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

impl<T: Ord> Ord for Tracks<T>

Source§

fn cmp(&self, other: &Tracks<T>) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 (const: unstable) · Source§

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

Compares and returns the maximum of two values. Read more
1.21.0 (const: unstable) · Source§

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

Compares and returns the minimum of two values. Read more
1.50.0 (const: unstable) · Source§

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

Restrict a value to a certain interval. Read more
Source§

impl<T: PartialEq> PartialEq for Tracks<T>

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl<T: PartialOrd> PartialOrd for Tracks<T>

Source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 (const: unstable) · Source§

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

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

impl<T: Serialize> Serialize for Tracks<T>

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

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

Auto Trait Implementations§

§

impl<T> Freeze for Tracks<T>
where T: Freeze,

§

impl<T> RefUnwindSafe for Tracks<T>
where T: RefUnwindSafe,

§

impl<T> Send for Tracks<T>
where T: Send,

§

impl<T> Sync for Tracks<T>
where T: Sync,

§

impl<T> Unpin for Tracks<T>
where T: Unpin,

§

impl<T> UnsafeUnpin for Tracks<T>
where T: UnsafeUnpin,

§

impl<T> UnwindSafe for Tracks<T>
where T: UnwindSafe,

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

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

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Comparable<K> for Q
where Q: Ord + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn compare(&self, key: &K) -> Ordering

Compare self to key and return their ordering.
Source§

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

Source§

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

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

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

Source§

fn equivalent(&self, key: &K) -> bool

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

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

fn clone_into(&self, target: &mut T)

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

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.