Struct PluginFactory 

pub struct PluginFactory<'a>(/* private fields */);

A Plugin Factory.

See the module documentation to learn more about the role of a Plugin Factory.

Implementations

impl<'a> PluginFactory<'a>

pub const fn raw(&self) -> RawFactoryPointer<'a, clap_plugin_factory>

Returns this factory as a raw pointer to its C-FFI compatible raw CLAP structure

pub fn plugin_count(&self) -> u32

Returns the number of plugin descriptors exposed by this plugin factory.

pub fn plugin_descriptor(&self, index: u32) -> Option<&'a PluginDescriptor>

Returns the PluginDescriptors exposed by this plugin factory at a given index, or None if there is no plugin descriptor at the given index.

Implementations on the plugin-side should return a descriptor for any index strictly less than plugin_count, but this is not a guarantee.

See also the plugin_descriptors method for a convenient iterator of all the plugin descriptors exposed by this factory.

pub fn plugin_descriptors(&self) -> PluginDescriptorsIter<'a>

Returns an iterator of all the PluginDescriptors exposed by this plugin factory.

For convenience, the &PluginFactory type implements the IntoIterator trait, which also returns this iterator.

See also the plugin_descriptor method to retrieve a plugin descriptor at a specific index.

Trait Implementations

impl<'a> Clone for PluginFactory<'a>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for PluginFactory<'a>

impl<'a> Factory<'a> for PluginFactory<'a>

const IDENTIFIERS: &'static [&'static CStr]

The standard identifier(s) for this factory type.

type Raw = clap_plugin_factory

The type of the raw, C-FFI compatible representation of this factory type.

unsafe fn from_raw( raw: RawFactoryPointer<'a, <PluginFactory<'a> as Factory<'a>>::Raw>, ) -> PluginFactory<'a>

Returns a handle to the factory from a given factory pointer.

impl<'a> IntoIterator for PluginFactory<'a>

Returns an iterator of all the PluginDescriptors exposed by this plugin factory.

type Item = &'a PluginDescriptor

The type of the elements being iterated over.

type IntoIter = PluginDescriptorsIter<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <PluginFactory<'a> as IntoIterator>::IntoIter

Creates an iterator from a value.