Struct InactivePluginMainThreadHandle 

pub struct InactivePluginMainThreadHandle<'a> { /* private fields */ }

A main-thread handle to the plugin, that can only exist while the plugin is in the ‘inactive’ state.

This is used by some extensions that e.g. require a function to be called on the main thread only if the plugin is inactive, and on the audio thread if it is active.

Implementations

impl<'a> InactivePluginMainThreadHandle<'a>

pub const fn as_raw(&self) -> &'a clap_plugin

Returns a shared reference to the raw, C-FFI compatible plugin instance struct.

This type enforces that the reference is valid for the lifetime of the instance ('a).

If you need to access the raw pointer without dereferencing it first, use as_raw_ptr instead.

pub const fn as_raw_ptr(&self) -> *const clap_plugin

Returns a raw pointer to the raw, C-FFI compatible plugin instance struct, without dereferencing it.

If you need to safely access the plugin instance struct through a shared reference, use as_raw instead.

pub const fn shared(&self) -> PluginSharedHandle<'a>

Produces a PluginSharedHandle from this main-thread handle.

pub const fn as_shared(&self) -> &PluginSharedHandle<'a>

Turns this handle reference to a PluginSharedHandle reference.

pub const fn as_main_thread(&mut self) -> &PluginMainThreadHandle<'a>

Turns this handle reference to an exclusive PluginMainThreadHandle reference.

This may be useful if you receive a InactivePluginMainThreadHandle but need to use some methods or extensions that do not care whether the plugin instance is currently active or not.

Only one of the InactivePluginMainThreadHandle and PluginMainThreadHandle may be used at the same time.

Methods from Deref<Target = PluginMainThreadHandle<'a>>

pub fn as_raw(&self) -> &'a clap_plugin

Returns a shared reference to the raw, C-FFI compatible plugin instance struct.

This type enforces that the reference is valid for the lifetime of the instance ('a).

If you need to access the raw pointer without dereferencing it first, use as_raw_ptr instead.

pub fn as_raw_ptr(&self) -> *const clap_plugin

Returns a raw pointer to the raw, C-FFI compatible plugin instance struct, without dereferencing it.

If you need to safely access the plugin instance struct through a shared reference, use as_raw instead.

pub fn shared(&self) -> PluginSharedHandle<'a>

Produces a PluginSharedHandle from this main-thread handle.

pub fn as_shared(&self) -> &PluginSharedHandle<'a>

Turns this handle reference to a PluginSharedHandle reference.

Methods from Deref<Target = PluginSharedHandle<'a>>

pub fn descriptor(&self) -> Option<&'a PluginDescriptor>

Returns the PluginDescriptor this instance corresponds to.

This may return None if the underlying plugin implementation didn’t properly populate the descriptor pointer.

pub fn as_raw(&self) -> &'a clap_plugin

Returns a shared reference to the raw, C-FFI compatible plugin instance struct.

This type enforces that the reference is valid for the lifetime of the instance ('a).

If you need to access the raw pointer without dereferencing it first, use as_raw_ptr instead.

pub fn as_raw_ptr(&self) -> *const clap_plugin

Returns a raw pointer to the raw, C-FFI compatible plugin instance struct, without dereferencing it.

If you need to safely access the plugin instance struct through a shared reference, use as_raw instead.

pub fn get_extension<E: Extension<ExtensionSide = PluginExtensionSide>>( &self, ) -> Option<E>

Retrieves the plugin’s pointer to the given extension type E.

This returns None if the plugin does not support the given extension.

Example

use clack_extensions::params::{PluginParams};
use clack_host::plugin::PluginSharedHandle;

let info: PluginSharedHandle = /* ... */
if let Some(params) = info.get_extension::<PluginParams>() {
    // The params extension is supported by this plugin
} else {
    // The params extension is not supported by this plugin
}

pub fn use_extension<E: Sized>( &self, extension: &RawExtension<PluginExtensionSide, E>, ) -> &'a E

Safely dereferences a RawExtension pointer produced by this plugin instance.

See the documentation of the RawExtension type for more information about how this works internally.

Panics

This method will panic if the given extension pointer does not match the plugin instance of this handle.

Trait Implementations

impl<'a> Clone for InactivePluginMainThreadHandle<'a>

fn clone(&self) -> InactivePluginMainThreadHandle<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for InactivePluginMainThreadHandle<'a>

impl Debug for InactivePluginMainThreadHandle<'_>

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

Formats the value using the given formatter.

impl<'a> Deref for InactivePluginMainThreadHandle<'a>

type Target = PluginMainThreadHandle<'a>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'a> Eq for InactivePluginMainThreadHandle<'a>

impl<'a> PartialEq for InactivePluginMainThreadHandle<'a>

fn eq(&self, other: &InactivePluginMainThreadHandle<'a>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<'a> StructuralPartialEq for InactivePluginMainThreadHandle<'a>