Struct PluginState 

pub struct PluginState { /* private fields */ }

A plugin’s persistable state: parameter values plus opaque keyed data.

Parameters are keyed by their numeric id and opaque data by string key, both in sorted BTreeMaps so serialization is deterministic. The state round-trips through an Expr map via PluginState::to_expr and PluginState::from_expr.

Implementations

impl PluginState

pub fn new() -> Self

Creates an empty state with no parameters and no data.

pub fn params(&self) -> &BTreeMap<u32, f64>

Returns the parameter id-to-value map.

pub fn data(&self) -> &BTreeMap<String, Expr>

Returns the opaque key-to-Expr data map.

pub fn set_param(&mut self, id: u32, value: f64)

Sets the value of the parameter with the given id, inserting it if absent.

pub fn param(&self, id: u32) -> Option<f64>

Returns the stored value for the parameter id, if present.

pub fn insert_data(&mut self, key: impl Into<String>, value: Expr)

Inserts or replaces an opaque data entry under key.

pub fn to_expr(&self) -> Expr

Encodes the state as a tagged Expr map.

The result is a plugin-core/state-tagged map carrying params and data vectors; PluginState::from_expr reverses it.

pub fn from_expr(expr: &Expr) -> Result<Self>

Decodes a state previously produced by PluginState::to_expr.

Errors

Returns an error when expr is not a plugin-core/state-tagged map or any required field has the wrong shape or numeric type.

Trait Implementations

impl Clone for PluginState

fn clone(&self) -> PluginState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PluginState

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

Formats the value using the given formatter.

impl Default for PluginState

fn default() -> PluginState

Returns the “default value” for a type.

impl PartialEq for PluginState

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for PluginState