Enum EffectCategory 

pub enum EffectCategory {
    IoFsRead,
    IoFsWrite,
    IoNetIn,
    IoNetOut,
    IoDbRead,
    IoDbWrite,
    StateGlobalRead,
    StateGlobalWrite,
    StateProcess,
    EnvRead,
    TimeRead,
    TimeSleep,
    Random,
    ProcSpawn,
    Throw,
    Log,
    Pure,
    Other(String),
}

Effect category — either a well-known built-in or a user-defined domain string (e.g. "midi.send", "audio.graph.connect").

User-defined categories are declared with asd effect declare --category and are not inferred automatically by language adapters. Well-known categories may be inferred.

Extensibility

The Other(String) variant accepts any dot-separated namespace string. Recommended namespaces for common domains:

• audio.* — audio engine operations (audio.graph.connect, audio.graph.disconnect)
• midi.* — MIDI I/O (midi.send, midi.receive)
• scheduler.* — sequencer/lane control (scheduler.restart, scheduler.stop)
• ui.* — UI state mutations (ui.state.mutate)
• file.* — higher-level import/export (file.import, file.export)

Variants

IoFsRead

IoFsWrite

IoNetIn

IoNetOut

IoDbRead

IoDbWrite

StateGlobalRead

StateGlobalWrite

StateProcess

EnvRead

TimeRead

TimeSleep

Random

ProcSpawn

Throw

Log

Pure

Other(String)

User-defined domain effect (e.g. "midi.send", "audio.graph.connect").

Implementations

impl EffectCategory

pub fn as_str(&self) -> &str

pub fn is_low_signal(&self) -> bool

Returns true for effects that are nearly universal and low-signal (appear on most symbols, rarely indicate a meaningful side-effect). Used to suppress noise in prepare_change and effects_of output. Low-signal effects are only shown when they are the only effects on a symbol.

pub fn from_str(s: &str) -> Self

Trait Implementations

impl Clone for EffectCategory

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EffectCategory

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for EffectCategory

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

Deserialize this value from the given Serde deserializer.

impl Eq for EffectCategory

impl Hash for EffectCategory

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 EffectCategory

fn cmp(&self, other: &Self) -> 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.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for EffectCategory

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for EffectCategory

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

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for EffectCategory