Struct PatchDef 

pub struct PatchDef {
    pub version: u32,
    pub name: String,
    pub author: Option<String>,
    pub description: Option<String>,
    pub tags: Vec<String>,
    pub output: Option<String>,
    pub modules: Vec<ModuleDef>,
    pub cables: Vec<CableDef>,
    pub parameters: HashMap<String, f64>,
}

Available on crate feature alloc only.

Serializable patch definition

Fields

version: u32

Schema version. See CURRENT_PATCH_VERSION for the compatibility policy: loaders accept version <= CURRENT_PATCH_VERSION and reject newer patches.

name: String

Patch metadata

author: Option<String>

description: Option<String>

tags: Vec<String>

Optional and additive: the published JSON schema marks tags optional (default []), so a hand-authored/tool-generated patch that omits the key must still load. serde(default) keeps deserialization in sync with the schema.

output: Option<String>

Name of the module whose output feeds the patch’s stereo out.

Optional and additive: patches written before this field existed omit it, and Patch::from_def then falls back to its output-node heuristic. Written by Patch::to_def whenever the patch has an output node set.

modules: Vec<ModuleDef>

Module instances

cables: Vec<CableDef>

Cable connections

parameters: HashMap<String, f64>

Parameter values (key: "module_name.param_id").

param_id is either a control-input port name (its unpatched base value) or an internal parameter id exposed via ModuleIntrospection. Applied by Patch::from_def through Patch::set_param_by_id; unknown keys are ignored so hand-edited files degrade gracefully.

Optional and additive: the schema marks parameters optional (default {}), so a patch that omits the key must still load. serde(default) keeps deserialization in sync.

Implementations

impl PatchDef

pub fn new(name: impl Into<String>) -> Self

Create a new empty patch definition

pub fn with_author(self, author: impl Into<String>) -> Self

Set the author

pub fn with_description(self, desc: impl Into<String>) -> Self

Set the description

pub fn with_tag(self, tag: impl Into<String>) -> Self

Add a tag

pub fn to_json(&self) -> Result<String, Error>

Serialize to JSON string

pub fn from_json(json: &str) -> Result<Self, Error>

Deserialize from JSON string

impl PatchDef

pub fn validate(&self) -> ValidationResult

Validate the patch definition without loading it

This performs structural validation to catch errors early before attempting to instantiate modules. For full semantic validation (e.g., checking that port names exist), use validate_with_registry.

pub fn validate_with_registry( &self, registry: &ModuleRegistry, ) -> ValidationResult

Validate the patch definition with registry context

This performs full semantic validation including checking that:

• All module types exist in the registry
• All port references point to existing modules
• All port names exist on their respective modules

Trait Implementations

impl Clone for PatchDef

fn clone(&self) -> PatchDef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PatchDef

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

Formats the value using the given formatter.

impl Default for PatchDef

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PatchDef

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FromWasmAbi for PatchDef

where Self: DeserializeOwned,

type Abi = <JsType as FromWasmAbi>::Abi

The Wasm ABI type that this converts from when coming back out from the ABI boundary.

unsafe fn from_abi(js: Self::Abi) -> Self

Recover a Self from Self::Abi.

impl IntoWasmAbi for PatchDef

where Self: Serialize,

type Abi = <JsType as IntoWasmAbi>::Abi

The Wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self) -> Self::Abi

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl OptionFromWasmAbi for PatchDef

where Self: DeserializeOwned,

fn is_none(js: &Self::Abi) -> bool

Tests whether the argument is a “none” instance. If so it will be deserialized as None, and otherwise it will be passed to FromWasmAbi.

impl OptionIntoWasmAbi for PatchDef

where Self: Serialize,

fn none() -> Self::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option.

impl Serialize for PatchDef

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Tsify for PatchDef

const DECL: &'static str = "export interface PatchDef {\n version: number;\n name: string;\n author: string | undefined;\n description: string | undefined;\n tags?: string[];\n output?: string | undefined;\n modules: ModuleDef[];\n cables: CableDef[];\n parameters?: StdMap<string, number>;\n}"

type JsType = JsType

Available on crate feature wasm-bindgen only.

fn into_js(&self) -> Result<Self::JsType, Error>

where Self: Serialize,

Available on crate feature js only.

fn from_js<T>(js: T) -> Result<Self, Error>

where T: Into<JsValue>, Self: DeserializeOwned,

Available on crate feature js only.

impl WasmDescribe for PatchDef

fn describe()