Enum FactoryWrapperError 

#[non_exhaustive]
pub enum FactoryWrapperError {
    NullFactoryInstance,
    NulPtr(&'static str),
    Panic,
    Error(clap_log_severity, Box<dyn Error>),
}

Errors raised by a FactoryWrapper.

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.

NullFactoryInstance

The factory raw pointer was null.

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.

Panic

The plugin factory panicked during a function call.

Error(clap_log_severity, Box<dyn Error>)

A generic or custom error of a given severity.

Implementations

impl FactoryWrapperError

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 with_severity<E: 'static + Error>( severity: clap_log_severity, ) -> impl Fn(E) -> FactoryWrapperError

Returns a closure that maps an error to a FactoryWrapperError::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 FactoryWrapperError

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

Formats the value using the given formatter.

impl Display for FactoryWrapperError

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

Formats the value using the given formatter.

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

fn from(value: E) -> Self

Converts to this type from the input type.