Struct CapeError

pub struct CapeError {
    pub(crate) interface: *mut ICapeError,
}

Error description from CAPE-OPEN object

Each CAPE-OPEN interface has an getLastError member function that returns an error interface for any call that results COBIAERR_CAPEOPENERROR.

This is a smart pointer to manage the error object and call its members.

Fields

interface: *mut ICapeError

Implementations

impl CapeError

pub fn from_interface_pointer(interface: *mut ICapeError) -> Self

Create a new CapeError from an ICapeError interface pointer.

The CapeError object is not typically used directly. Errors are managed through the COBIAError object, which also manages the CapeError based errors raised by CAPE-OPEN objects.

Arguments

• interface - A pointer to an ICapeError interface

Safety

The interface pointer must be non-null and must point to an object that implements the ICapeError interface.

Panics

Panics if the interface pointer is null.

pub fn attach(interface: *mut ICapeError) -> Self

Create a new CapeError from an ICapeError interface pointer without adding a reference.

The CapeError object is not typically used directly. Errors are managed through the COBIAError object, which also manages the CapeError based errors raised by CAPE-OPEN objects.

Arguments

• interface - A pointer to an ICapeError interface

Safety

The interface pointer must be non-null and must point to an object that implements the ICapeError interface.

Panics

Panics if the interface pointer is null.

pub fn get_error_text(&self) -> Result<String, COBIAError>

Get the error text

Gets the error text from the error interface. The error text is descriptive information about the nature of the error.

pub fn get_cause(&self) -> Option<CapeError>

Get the error that caused this error.

Sometimes an error is casued by another error. If so, the error that causes this error is available through this function.

pub fn get_source(&self) -> Result<String, COBIAError>

Get the error source

The error source is a descriptive name of the object that raised the error.

pub fn get_scope(&self) -> Result<String, COBIAError>

Get the error scope

The error scope is the function that was being executed when the error was raised.

Trait Implementations

impl Clone for CapeError

Add pointer reference

ICapeError derives from ICobiaBase, which contains addReference() and release(). The Clone trait calls addReference.

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Display for CapeError

Display

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

Formats the value using the given formatter.

impl Drop for CapeError

Release pointer

ICapeError derives from ICobiaBase, which contains addReference() and release(). The Drop trait calls release.

fn drop(&mut self)

Executes the destructor for this type.