Skip to main content

FfiStatus

Enum FfiStatus 

Source
#[repr(u32)]
pub enum FfiStatus { Ok = 0, Exception = 1, Fatal = 99, }
Expand description

Discriminator for FfiReturn::status.

On the wire the status is a plain u32 (an arbitrary integer from a plugin must not become a Rust enum); decode with FfiStatus::from_u32, encode with as u32.

Variants§

§

Ok = 0

Success - value is the call’s result.

§

Exception = 1

value is the exception instance.

From a host callback this is the exception generic code raised, handed over with full identity: returning the same value (the safe wrapper’s ? does) re-raises exactly that exception - class, fields, and original stack trace intact. To throw a fresh exception, create the instance with HostApi::exception_new and return it under this status; a caught one can be examined with HostApi::is_instance against a class from HostApi::builtin_get.

§

Fatal = 99

A fatal host runtime error passing through the plugin.

Not an exception - it is uncatchable. A re-entering host callback returns it when the interpreter hit a fatal error; the plugin must forward it unchanged (the safe wrapper’s ? does), and the host re-raises it as a fatal error when the plugin call returns. value carries no meaning for this status.

Implementations§

Source§

impl FfiStatus

Source

pub const fn from_u32(status: u32) -> Option<Self>

Decode a raw status. None means the value is not a valid status - a protocol violation the host surfaces as a plugin bug (there is no safe fallback: value must not be interpreted at all).

Trait Implementations§

Source§

impl Clone for FfiStatus

Source§

fn clone(&self) -> FfiStatus

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for FfiStatus

Source§

impl Debug for FfiStatus

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for FfiStatus

Source§

impl PartialEq for FfiStatus

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for FfiStatus

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.