Struct PluginContext 

pub struct PluginContext<P = dyn Params>
where
    P: ?Sized,
{ /* private fields */ }

Context passed to Editor::open. Carries:

• An Arc<dyn EditorBridge> - the host-plugin protocol surface (begin/set/end edit, request_resize, get_state, transport, …).
• An Arc<P> typed parameter store - plugin authors Deref to &P and read fields directly: state.gain.read().

The default P = dyn Params keeps the trait-object boundary (Editor::open(ctx: PluginContext)) one-typed; editor crates that want typed access (truce-egui, truce-slint, truce-iced) carry their own <P> and reconstitute PluginContext<P> internally via PluginContext::with_params using the Arc<P> they stored at editor construction.

Clone is two refcount bumps (bridge + params). Editors that need to hand the context to UI worker threads or animation timers clone freely.

Implementations

impl<P> PluginContext<P>

where P: ?Sized,

pub fn new(bridge: Arc<dyn EditorBridge>, params: Arc<P>) -> PluginContext<P>

Build a typed context from any EditorBridge implementor and the plugin’s typed param store.

pub fn bridge(&self) -> &Arc<dyn EditorBridge>

Access the underlying bridge handle. Editors that want to clone the bridge into a worker thread without cloning the surrounding PluginContext use this.

pub fn params(&self) -> &Arc<P>

Access the typed param store as an Arc. Use this when you need to capture the params in a 'static closure (e.g. an iced Subscription or a worker thread).

pub fn with_params<Q>(&self, params: Arc<Q>) -> PluginContext<Q>

where Q: ?Sized,

Replace the param-store generic parameter while reusing the same bridge. Used by editor crates that receive the dyn-erased PluginContext from Editor::open and want the typed PluginContext<P> for their UI closure.

pub fn begin_edit(&self, id: impl Into<u32>)

pub fn set_param(&self, id: impl Into<u32>, normalized: f64)

pub fn end_edit(&self, id: impl Into<u32>)

pub fn automate(&self, id: impl Into<u32>, normalized: f64)

Begin + set + end in one call. Use for click-to-toggle widgets and similar single-shot edits where the gesture and the value arrive together.

pub fn request_resize(&self, w: u32, h: u32) -> bool

pub fn format_param(&self, id: impl Into<u32>) -> String

pub fn format_param_into(&self, id: impl Into<u32>, out: &mut String)

Format into a caller-owned buffer. See EditorBridge::format_param_into for the allocation trade-off - the caller’s buffer is reused, but bridges that don’t override the default impl still allocate internally.

pub fn get_meter(&self, id: impl Into<u32>) -> f32

pub fn get_state(&self) -> Vec<u8>

pub fn set_state(&self, data: Vec<u8>)

pub fn transport(&self) -> Option<TransportInfo>

impl PluginContext

pub fn from_closures( bridge: ClosureBridge, params: Arc<dyn Params>, ) -> PluginContext

Build a dyn-erased context from a ClosureBridge. Convenience for format wrappers that compose state inline via closures.

impl<P> PluginContext<P>

where P: Params + 'static,

pub fn dyn_erase(self) -> PluginContext

Drop the typed <P> and return the dyn-erased context that crosses the Editor::open trait-object boundary.

Trait Implementations

impl<P> Clone for PluginContext<P>

where P: ?Sized,

fn clone(&self) -> PluginContext<P>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<P> Deref for PluginContext<P>

where P: ?Sized,

Plugin authors read parameter fields directly via Deref: state.gain.read(), state.bypass.value(). The state here is &PluginContext<MyParams> and Deref::Target = MyParams.

type Target = P

The resulting type after dereferencing.

fn deref(&self) -> &P

Dereferences the value.

impl<P> PluginContextReadF32 for PluginContext<P>

where P: ?Sized,

fn get_param(&self, id: impl Into<u32>) -> f32

Normalized [0, 1] value of the parameter, narrowed to f32.

fn get_param_plain(&self, id: impl Into<u32>) -> f32

Plain (denormalized) value of the parameter, narrowed to f32.

impl<P> PluginContextReadF64 for PluginContext<P>

where P: ?Sized,

fn get_param(&self, id: impl Into<u32>) -> f64

Normalized [0, 1] value of the parameter.

fn get_param_plain(&self, id: impl Into<u32>) -> f64

Plain (denormalized) value of the parameter.