Struct Patch 

pub struct Patch {
    pub doc: SoundDoc,
    pub params: Vec<ParamSpec>,
}

A SoundDoc template plus its parameters. Ships as JSON; loaded and rendered at runtime with per-instance values.

Fields

doc: SoundDoc

The template document.

params: Vec<ParamSpec>

The parameters that vary it.

Implementations

impl Patch

pub fn new(doc: SoundDoc) -> Self

A patch around doc with no parameters yet — add ParamSpecs to expose knobs.

pub fn instantiate( &self, values: &BTreeMap<String, f32>, ) -> Result<SoundDoc, EditError>

Bake the patch into a concrete document with the given parameter values (missing → default, out-of-range → clamped). Validated like any edit, so a bad path or value is a clear error, never a corrupt graph.

pub fn render( &self, values: &BTreeMap<String, f32>, ) -> Result<Vec<f32>, EditError>

Instantiate and render to mono samples — the one call a game makes per SFX instance.

pub fn defaults(&self) -> BTreeMap<String, f32>

The parameter defaults as a value map — a starting point to tweak.

Trait Implementations

impl Clone for Patch

fn clone(&self) -> Patch

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Patch

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Patch

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<SoundDoc> for Patch

fn from(doc: SoundDoc) -> Self

Converts to this type from the input type.

impl JsonSchema for Patch

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Serialize for Patch

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

where __S: Serializer,

Serialize this value into the given Serde serializer.