Skip to main content

HostError

Enum HostError 

Source
pub enum HostError {
    Error(Box<dyn Error + 'static>),
    Message(&'static str),
}
Expand description

A generic, type-erased error type for host-originating errors.

Errors are type-erased because the CLAP API does not support extracting error information from a plugin or host, only that an error happened.

Errors originating from a user-provided host callback implementation are simply logged through the host’s provided logging facilities if available, or the standard error output (stderr) if not.

This error can be constructed either from any existing Error type, or from an arbitrary error message.

§Example

use std::io;
use clack_host::prelude::HostError;

fn foo () -> io::Result<()> {
    /* ... */
}

fn perform(valid: bool) -> Result<(), HostError> {
    if !valid {
        return Err(HostError::Message("Invalid value"))
    }
    /* ... */
    foo()?;
    /* ... */
    Ok(())
}

Variants§

§

Error(Box<dyn Error + 'static>)

A generic, type-erased error.

§

Message(&'static str)

A constant string message to be displayed.

Trait Implementations§

Source§

impl Debug for HostError

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for HostError

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<E: Error + 'static> From<E> for HostError

Source§

fn from(e: E) -> Self

Converts to this type from the input type.
Source§

impl From<HostError> for HostWrapperError

Source§

fn from(value: HostError) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.