Struct HostInfo 

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

Various information about the host, provided at plugin instantiation time.

Implementations

impl<'a> HostInfo<'a>

pub const unsafe fn from_raw(raw: NonNull<clap_host>) -> Self

Creates a new HostInfo type from a given raw, C FFI compatible pointer.

Safety

Pointer must be valid for the duration of the 'a lifetime. Moreover, the contents of the clap_host struct must all also be valid.

pub const fn clap_version(&self) -> ClapVersion

The ClapVersion the host uses.

pub const fn name(&self) -> Option<&'a CStr>

A user-friendly name for the host (e.g. “Bitwig Studio”).

This should always be set by the host.

pub const fn vendor(&self) -> Option<&'a CStr>

The host’s vendor (e.g. “Bitwig GmbH”).

This field is optional.

pub const fn url(&self) -> Option<&'a CStr>

A URL to the host’s webpage.

This field is optional.

pub const fn version(&self) -> Option<&'a CStr>

A version string for the host (e.g. “4.3”).

This should always be set by the host.

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

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

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

Example

use clack_extensions::log::{HostLog, LogSeverity};
use clack_plugin::host::HostInfo;

let info: HostInfo = /* ... */
if let Some(log) = info.get_extension::<HostLog>() {
    // The log extension is supported by this host
} else {
    // The log extension is not supported by this host
}

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

Returns a raw, C FFI-compatible reference to the host handle.

Trait Implementations

impl<'a> Clone for HostInfo<'a>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for HostInfo<'a>

impl<'a> From<HostSharedHandle<'a>> for HostInfo<'a>

fn from(h: HostSharedHandle<'a>) -> Self

Converts to this type from the input type.