Skip to main content

InitContext

Struct InitContext 

Source
pub struct InitContext { /* private fields */ }
Expand description

Context handed to init so a plugin can schedule startup background work before the first block. Concrete (not generic over the task type) because init’s signature lives on the leaf trait; recover the typed spawner with Self::tasks. Params arrive as the separate init argument.

Implementations§

Source§

impl InitContext

Source

pub fn new(tasks: Option<AnyTaskSpawner>) -> Self

Source

pub fn with_snapshot(self, snapshot: SnapshotPublisher) -> Self

Attach the off-thread snapshot publisher (see SnapshotPublisher).

Source

pub fn tasks<T: Send + 'static>(&self) -> Option<TaskSpawner<T>>

The task spawner for task type T, or None if the plugin declared no tasks: lane of that type on plugin!.

Source

pub fn snapshot_publisher(&self) -> Option<SnapshotPublisher>

Handle to publish large custom state off the audio thread. Stash it in your DSP state and call publish from a background-task handler after your state changes. None in --shell builds; use snapshot_into for small state, which works everywhere.

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> 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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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.