Enum PluginWrapperError 

#[non_exhaustive]
pub enum PluginWrapperError {
    NullPluginInstance,
    AlreadyDestroyed,
    NulPtr(&'static str),
    InvalidParameter(&'static str),
    UninitializedPlugin,
    PluginCalledDuringInitialization,
    Destroying,
    InitializationAlreadyFailed,
    AlreadyInitialized,
    ActivatedPlugin,
    DeactivatedPlugin,
    DeactivationRequiredForFunction(&'static str),
    Panic,
    Plugin(PluginError),
    StringEncoding(Utf8Error),
    InvalidCString(NulError),
    ErrorFormatError(Error),
    Error(clap_log_severity, Box<dyn Error>),
    Message(clap_log_severity, &'static str),
}

Errors raised by a PluginWrapper.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

NullPluginInstance

The clap_plugin raw pointer was null.

AlreadyDestroyed

The clap_plugin.plugin_data raw pointer was null, which indicates the instance was already destroyed.

NulPtr(&'static str)

An unexpectedly null raw pointer was encountered.

The given string may contain more information about which pointer was found to be null.

InvalidParameter(&'static str)

An invalid parameter value was encountered.

The given string may contain more information about which parameter was found to be invalid.

UninitializedPlugin

The plugin was not properly initialized (i.e. init was not called).

PluginCalledDuringInitialization

The host tried to call a plugin method while init is running.

Destroying

The host tried to call a plugin method while destroy is running.

InitializationAlreadyFailed

The plugin’s initialization (init) has failed.

AlreadyInitialized

The plugin is already initialized (i.e. a second call to init was attempted).

ActivatedPlugin

An attempt was made to call activate on an already activated plugin.

DeactivatedPlugin

An attempt was made to call an audio-thread function while the plugin was deactivated (e.g. without previously calling activate).

DeactivationRequiredForFunction(&'static str)

A function which requires the plugin to be deactivated was called while the plugin was still active.

Panic

The plugin panicked during a function call.

Plugin(PluginError)

A given PluginError was raised during a function call.

StringEncoding(Utf8Error)

Bad UTF-8.

InvalidCString(NulError)

Plugin returned a malformed C string.

ErrorFormatError(Error)

Encountered an error while trying to format another PluginWrapperError

Error(clap_log_severity, Box<dyn Error>)

A generic or custom error of a given severity.

Message(clap_log_severity, &'static str)

A constant string message to be displayed.

Implementations

impl PluginWrapperError

pub fn severity(&self) -> clap_log_severity

Returns the severity of this error.

This is mainly useful for logging.

Example

use clap_sys::ext::log::CLAP_LOG_PLUGIN_MISBEHAVING;
use clack_plugin::extensions::wrapper::PluginWrapperError;
let error = PluginWrapperError::Panic;

assert_eq!(error.severity(), CLAP_LOG_PLUGIN_MISBEHAVING);

pub fn os_error_code(&self) -> Option<i32>

If this error holds an io::Error, returns its raw OS error.

If not applicable, this returns None instead.

pub fn format_cstr(&self) -> Cow<'static, CStr>

Formats this error into either a CStr or CString.

This will handle formatting failures and return an appropriate message in that case, so unlike the Display implementation, this will always return a displayable error message.

pub fn with_severity<E: 'static + Error>( severity: clap_log_severity, ) -> impl Fn(E) -> PluginWrapperError

Returns a closure that maps an error to a PluginWrapperError::Error error of a given severity.

This is a useful helper method when paired with Result::map_err.

Example

use clap_sys::ext::log::CLAP_LOG_PLUGIN_MISBEHAVING;
use clack_plugin::extensions::wrapper::PluginWrapperError;

let x: Result<(), _> = Err(std::env::VarError::NotPresent); // Some random error type
let clap_error = x.map_err(PluginWrapperError::with_severity(CLAP_LOG_PLUGIN_MISBEHAVING));

assert_eq!(clap_error.unwrap_err().severity(), CLAP_LOG_PLUGIN_MISBEHAVING);

Trait Implementations

impl Debug for PluginWrapperError

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

Formats the value using the given formatter.

impl Display for PluginWrapperError

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

Formats the value using the given formatter.

impl Error for PluginWrapperError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<PluginError> for PluginWrapperError

fn from(e: PluginError) -> Self

Converts to this type from the input type.