Struct Host

pub struct Host { /* private fields */ }

Implementations

impl Host

pub const fn clap_host(&self) -> &clap_host

pub const fn clap_version(&self) -> ClapVersion

pub const fn get_extension(&self) -> HostExtensions<'_>

Examples found in repository

examples/plugin_template.rs (line 66)

    fn init(&mut self, host: Arc<clap::Host>) -> Result<(), clap::Error> {
        // Store the reference to the host.
        self.host = Some(host.clone());

        // We can retrieve host extensions here. E.g., the logging facility:
        host.get_extension().log()?.info("hello, sonic world")?;
        Ok(())
    }

impl Host

pub fn name(&self) -> &str

Panic

This method will panic if the host returns an invalid UTF-8 string.

pub fn vendor(&self) -> &str

Panic

This method will panic if the host returns an invalid UTF-8 string.

pub fn url(&self) -> &str

Panic

This method will panic if the host returns an invalid UTF-8 string.

pub fn version(&self) -> &str

Panic

This method will panic if the host returns an invalid UTF-8 string.

impl Host

pub fn request_process(&self)

pub fn request_restart(&self)

pub fn request_callback(&self)

Trait Implementations

impl Debug for Host

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

Formats the value using the given formatter.

impl PartialEq for Host

fn eq(&self, other: &Host) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Send for Host

impl StructuralPartialEq for Host

impl Sync for Host