Struct rytm_rs::object::kit::retrig::TrackRetrigMenu

pub struct TrackRetrigMenu { /* private fields */ }

Represents the retrig settings for a track.

Implementations

impl TrackRetrigMenu

pub fn try_default_for_track(track_index: usize) -> Result<Self, RytmError>

pub fn set_rate(&mut self, rate: RetrigRate)

Sets the retrig rate.

pub fn set_length(&mut self, length: Length)

Sets the retrig length.

pub fn set_velocity_curve( &mut self, velocity_curve: isize ) -> Result<(), RytmError>

Sets the velocity curve.

Range: -128..=127

pub fn set_always_on(&mut self, always_on: bool)

Sets whether the retrig is always on.

If true, the retrig is always on.

pub const fn track_index(&self) -> usize

Returns the track index. The track which this setting belongs to.

Range: 0..=12

pub const fn rate(&self) -> RetrigRate

Returns the retrig rate.

pub const fn length(&self) -> Length

Returns the retrig length.

pub const fn velocity_curve(&self) -> i8

Returns the velocity curve.

Range: -128..=127

pub const fn always_on(&self) -> bool

Returns whether the retrig is always on.

If true, the retrig is always on.

Trait Implementations

impl Clone for TrackRetrigMenu

fn clone(&self) -> TrackRetrigMenu

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TrackRetrigMenu

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TrackRetrigMenu

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for TrackRetrigMenu

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 Ord for TrackRetrigMenu

fn cmp(&self, other: &TrackRetrigMenu) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for TrackRetrigMenu

fn eq(&self, other: &TrackRetrigMenu) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for TrackRetrigMenu

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for TrackRetrigMenu

impl Eq for TrackRetrigMenu

impl StructuralEq for TrackRetrigMenu

impl StructuralPartialEq for TrackRetrigMenu