Enum sorceress::synthdef::DoneAction

pub enum DoneAction {
    None,
    PauseSelf,
    FreeSelf,
    FreeSelfAndPrev,
    FreeSelfAndNext,
    FreeSelfAndFreeAllInPrev,
    FreeSelfAndFreeAllInNext,
    FreeSelfToHead,
    FreeSelfToTail,
    FreeSelfPausePrev,
    FreeSelfPauseNext,
    FreeSelfAndDeepFreePrev,
    FreeSelfAndDeepFreeNext,
    FreeAllInGroup,
    FreeGroup,
    FreeSelfResumeNext,
}

An action to invoke when a UGen is finished playing.

A number of UGens implement “done actions”. These allow one to optionally free or pause the enclosing synth and other related nodes when the UGen is finished.

Variants

None

Do nothing when the UGen is finished.

PauseSelf

Pause the enclosing synth, but do not free it.

FreeSelf

Free the enclosing synth.

FreeSelfAndPrev

Free both this synth and the preceding node.

FreeSelfAndNext

Free both this synth and the following node.

FreeSelfAndFreeAllInPrev

Free this synth; if the preceding node is a group then do g_freeAll on it, else free it.

FreeSelfAndFreeAllInNext

Free this synth; if the following node is a group then do g_freeAll on it, else free it.

FreeSelfToHead

Free this synth and all preceding nodes in this group.

FreeSelfToTail

Free this synth and all following nodes in this group.

FreeSelfPausePrev

Free this synth and pause the preceding node.

FreeSelfPauseNext

Free this synth and pause the following node.

FreeSelfAndDeepFreePrev

Free this synth and if the preceding node is a group then deep free it, else free it.

FreeSelfAndDeepFreeNext

Free this synth and if the following node is a group then deep free it, else free it.

FreeAllInGroup

Free this synth and all other nodes in this group (before and after).

FreeGroup

Free the enclosing group and all nodes within it (including this synth).

FreeSelfResumeNext

Free this synth and resume the following node.

Trait Implementations

impl Clone for DoneAction

fn clone(&self) -> DoneAction

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for DoneAction

impl Debug for DoneAction

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

Formats the value using the given formatter.

impl Default for DoneAction

fn default() -> DoneAction

Returns the “default value” for a type.

impl Eq for DoneAction

impl Hash for DoneAction

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl Input for DoneAction

fn into_value(self) -> Value

Converts the input into a Value.

fn add(self, rhs: impl Input) -> Value

Adds an Input to another.

fn sub(self, rhs: impl Input) -> Value

Subtracts an Input from another.

fn mul(self, rhs: impl Input) -> Value

Multiplies an Input by another.

fn div(self, rhs: impl Input) -> Value

Divides an Input by another using floating point division.

fn idiv(self, rhs: impl Input) -> Value

Divides an Input by another using integer division.

fn modulo(self, divisor: impl Input) -> Value

Modulo operator.

fn madd(self, mul: impl Input, add: impl Input) -> Value

Efficiently multiplies the signal by mul and adds add.

fn midicps(self) -> Value

Converts midi note numbers into cycles per seconds (Hz).

fn cpsmidi(self) -> Value

Converts cycles per seconds (Hz) into midi note numbers.

fn range(self, lo: impl Input, hi: impl Input) -> Value

Scales the output of this UGen to be within the range of lo and hi.

impl Ord for DoneAction

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

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<DoneAction> for DoneAction

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

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

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<DoneAction> for DoneAction

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

This method returns an ordering between self and other values if one exists.

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

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

#[must_use]pub fn le(&self, other: &Rhs) -> bool

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

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

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

#[must_use]pub 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 StructuralEq for DoneAction

impl StructuralPartialEq for DoneAction