Struct ForeignError 

pub struct ForeignError {
    pub code: i32,
    pub message: String,
    pub payload: Vec<u8>,
}

A failure a consumer’s callback-interface implementation reported, or a value it returned that the producer couldn’t accept.

Every callback trait method returns Result<T, ForeignError>. code is FOREIGN_ERROR_CODE for any consumer failure, except that a method declared throws keeps a code of its module’s error domain, whose fields domain decodes. A malformed return value (a string that isn’t UTF-8, a null object, a bad enum value or buffer) has the code MARSHAL_ERROR_CODE.

Fields

code: i32

The failure’s code (see the type’s docs).

message: String

The consumer’s message, copied out of out_err before it was freed.

payload: Vec<u8>

The domain code’s fields as a value buffer, or empty.

Implementations

impl ForeignError

pub fn new(code: i32, message: impl Into<String>) -> Self

A failure with code and message and no payload.

pub fn domain<E: ErrorDomain>(&self) -> Option<E>

Decode a domain error the consumer reported: Some when code is one of E’s declared codes and the payload holds that code’s fields.

Object fields can’t be decoded here (a callback’s error payload may not carry object references), so a code whose fields include an interface yields None.

Trait Implementations

impl Clone for ForeignError

fn clone(&self) -> ForeignError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ForeignError

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

Formats the value using the given formatter.

impl Display for ForeignError

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

Formats the value using the given formatter.

impl Eq for ForeignError

impl Error for ForeignError

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 ErrorReport for ForeignError

A ForeignError is reported with its own code, message, and payload, so a producer function whose error type is ForeignError can propagate a callback failure with ?.

fn code(&self) -> i32

The non-zero status code written to FfiError::code. Defaults to GENERIC_ERROR_CODE.

fn message(&self) -> String

The human-readable message written to FfiError::message.

fn payload(&self) -> Vec<u8>

The serialized payload fields written to FfiError::payload_ptr, or an empty vector for a code with no fields.

impl PartialEq for ForeignError

fn eq(&self, other: &ForeignError) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for ForeignError