Enum COBIAError

pub enum COBIAError {
    Message(String),
    MessageWithCause(String, CapeError),
    Code(CapeResult),
    CAPEOPEN(CapeError),
}

A COBIA error, with description

Many functions in this module return a Result with the error type set to COBIAError. A COBIAError can be constructed from

• a string message, for an internal error message
• a CapeResult error code, for an internal message that corresponds to a predefined CAPE-OPEN error code
• a CapeError, for an error that was returned by an external CAPE-OPEN component
• a string message and a CapeError, for an internal error message that was caused by an external CAPE-OPEN component

The COBIAError type implements the Error trait, so it can be used in functions that return Result. The COBIAError type also implements the Display trait, so it can be formatted as a string.

Variants

Message(String)

MessageWithCause(String, CapeError)

Code(CapeResult)

CAPEOPEN(CapeError)

Implementations

impl COBIAError

pub fn as_code(&self) -> CapeResult

pub fn from_object<T: CapeSmartPointer>(code: CapeResult, object: &T) -> Self

pub fn from_cape_interface_pointer( code: CapeResult, interface: *mut ICapeInterface, ) -> Self

Trait Implementations

impl Clone for COBIAError

fn clone(&self) -> COBIAError

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for COBIAError

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

Formats the COBIA error using the given formatter.

impl Display for COBIAError

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

Formats the COBIA error using the given formatter.

impl Error for COBIAError

Implements the Error trait for COBIAError

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 Into<String> for COBIAError

fn into(self) -> String

Converts this type into the (usually inferred) input type.