Struct HostInfo 

pub struct HostInfo { /* private fields */ }

Human-readable information and description about the host.

This information is passed to plugins at instantiation time by PluginInstance::new.

See the new method’s documentation for an example of how to instantiate it.

Implementations

impl HostInfo

pub fn new( name: &str, vendor: &str, url: &str, version: &str, ) -> Result<Self, NulError>

Creates a new host information container from its components.

• name: The name of the host. Example: "Bitwig Studio"
• vendor: The software vendor of the host. Example: "Bitwig GmbH"
• url: Example: "https://bitwig.com"
• version: The version string of the host. Example: "4.3.2"

All parameters are copied into new string buffers.

Errors

All parameters must not contain the null (\0) character. If any of them do, a NulError is returned.

Example

use clack_host::host::HostInfo;

let info = HostInfo::new("Bitwig Studio", "Bitwig GmbH", "https://bitwig.com", "4.3.2");

pub fn new_from_cstring( name: CString, vendor: CString, url: CString, version: CString, ) -> Self

An infallible version of new.

This method takes ownership of preexisting CString buffers, and therefore cannot fail from null byte errors, and performs fewer allocations compared to new.

See the documentation for new for more information about the arguments.

pub fn from_plugin(info: &HostInfo<'_>) -> Self

Available on crate feature clack-plugin only.

Creates a new host information container using the data originally provided to a plugin.

pub fn name(&self) -> &CStr

Returns the name of the host.

pub fn vendor(&self) -> &CStr

Returns the software vendor of the host.

pub fn url(&self) -> &CStr

Returns the host’s web homepage’s URL.

pub fn version(&self) -> &CStr

Returns the version string of the host

Trait Implementations

impl Clone for HostInfo

fn clone(&self) -> HostInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HostInfo

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

Formats the value using the given formatter.