Struct HostLog

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

Implementations

impl<'a> HostLog<'a>

pub fn log_cstr(&self, severity: Severity, msg: &CStr)

Send a CStr to the host’s log.

By logging a CStr, instead of &str, the function avoids memory allocation, and a fallible Rust-string-to-C-string conversion.

pub fn log(&self, severity: Severity, msg: &str) -> Result<(), Error>

impl<'a> HostLog<'a>

pub fn debug(&self, msg: &str) -> Result<(), Error>

pub fn info(&self, msg: &str) -> Result<(), Error>

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(())
    }

pub fn warning(&self, msg: &str) -> Result<(), Error>

pub fn error(&self, msg: &str) -> Result<(), Error>

pub fn fatal(&self, msg: &str) -> Result<(), Error>

Trait Implementations

impl<'a> Debug for HostLog<'a>

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

Formats the value using the given formatter.