Struct UniversalPluginId 

pub struct UniversalPluginId<'a> {
    pub abi: &'a CStr,
    pub id: &'a CStr,
}

A unique identifier that works across plugin APIs.

This is a (abi, id) pair of borrowed strings that live for the 'a lifetime.

Fields

abi: &'a CStr

The ABI string.

It can be e.g. “clap”, “vst2”, “vst3”, “au”, etc.

See UniversalPluginAbi::abi_str for known values this field can take.

id: &'a CStr

The ID string of the plugin.

This is formatted differently depending on the ABI type:

• CLAP: Use the plugin ID (e.g. "com.u-he.diva")
• AU: Format the string as “type:subt:manu” (e.g. "aumu:SgXT:VmbA")
• VST2: Format the ID as a signed 32-bit integer (e.g. "-4382976")
• VST3: Format the ID as a hyphenated UUID (e.g. "123e4567-e89b-12d3-a456-426614174000")

Implementations

impl<'a> UniversalPluginId<'a>

pub const unsafe fn from_raw( raw: clap_universal_plugin_id, ) -> Option<UniversalPluginId<'a>>

Creates a UniversalPluginId from its raw, C-FFI compatible representation.

If either of the string pointers within the given struct are NULL, this returns None.

Safety

Either of the contained pointers can be NULL, in which case the following requirements do not apply.

Both pointers must point to valid C strings, and remain valid for the duration of the 'a lifetime.

See the documentation of CStr::from_ptr for the exhaustive list of safety requirements.

pub const unsafe fn from_raw_ptr( ptr: *const clap_universal_plugin_id, ) -> Option<UniversalPluginId<'a>>

Creates a UniversalPluginId from a pointer to its raw, C-FFI compatible representation.

If the given ptr, or either of the string pointers within the pointed struct are NULL, this returns None.

This function is a version of the from_raw method, except it allows to read directly from a raw pointer without actually borrowing it, which may be slightly safer.

Safety

The given ptr must be well-aligned and valid for that. On top of that, the clap_universal_plugin_id value it points to must also satisfy the safety requirements of the from_raw method.

pub const fn clap(id: &'a CStr) -> UniversalPluginId<'a>

Creates a UniversalPluginId for a CLAP plugin with a given id.

pub const fn abi(&self) -> Option<UniversalPluginAbi>

Returns the UniversalPluginAbi matching this ID’s plugin ABI.

If the ABI type string doesn’t match a known UniversalPluginAbi variant, this returns None.

pub const fn to_raw(&self) -> clap_universal_plugin_id

Returns a raw, C-FFI compatible representation of this ID.

The pointers contained in this struct are valid for the 'a lifetime.

Trait Implementations

impl<'a> Clone for UniversalPluginId<'a>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for UniversalPluginId<'a>

impl<'a> Debug for UniversalPluginId<'a>

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

Formats the value using the given formatter.

impl<'a> Eq for UniversalPluginId<'a>

impl<'a> Hash for UniversalPluginId<'a>

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a> PartialEq for UniversalPluginId<'a>

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

Equality operator ==.

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

Inequality operator !=.

impl<'a> StructuralPartialEq for UniversalPluginId<'a>