Skip to main content

RackModule

Struct RackModule 

Source
pub struct RackModule {
    pub key: String,
    pub uid: u64,
    pub kind: String,
    pub title: String,
    pub column: usize,
    pub is_mod: bool,
    pub knobs: Vec<Knob>,
    pub structural_addrs: Vec<String>,
}
Expand description

One module faceplate in the rack.

Fields§

§key: String

Trace key of the node (node, node/0, node/0/m, node/0/m/0, amp). A modulation chain’s stages nest under the slot with the same /0, /1 child convention the audio tree uses.

§uid: u64

Stable node identity — Uid, flattened to its number, or 0 for the amp pseudo-module, which is the envelope wrapping the term rather than a node in it.

key is the wire protocol: it is what a StructOp names, what a trace address is built from, and what the engine understands. uid is the identity — the same module before and after an insert above it, a delete beside it, or a generation of refinement — and it is what the panel keys locks, hand positions and selection by. Anything that has to survive an edit is keyed by this; anything the engine has to read is keyed by key.

§kind: String

Machine kind tag (vco, filter, lfo, amp, …).

§title: String

Silkscreen title.

§column: usize

Distance from the root (root = 0); layout hint for column placement.

§is_mod: bool

True for modulation-sort modules — the ones that live at or below a <key>/m slot rather than in the audio path.

As of wave 2C that is a whole sort rather than four leaves: the generators (lfo, mod env, s&h rand, follower, euclid), the CV processors that wrap them (quantize, slew, rectify, hold) and the combiners that join two (min, max, and, or, xor, switch). A chain is drawn as a run of modules with mod wires between them, each one column further from the destination.

§knobs: Vec<Knob>

The knobs, in faceplate order.

§structural_addrs: Vec<String>

Structural choice addresses owned by this module (#leaf, #src, #op, #mod, and any empty mod slot it guards). Locking the module means locking these plus all knob addresses — evolution can then not replace or restructure it.

Trait Implementations§

Source§

impl Clone for RackModule

Source§

fn clone(&self) -> RackModule

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 Debug for RackModule

Source§

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

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

impl<'de> Deserialize<'de> for RackModule

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 PartialEq for RackModule

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for RackModule

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 StructuralPartialEq for RackModule

Auto Trait Implementations§

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<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> 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.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

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

§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,