Skip to main content

PixelflowStatus

Struct PixelflowStatus 

Source
#[repr(C)]
pub struct PixelflowStatus { pub size: u32, pub version: u32, pub status_code: i32, pub category: PixelflowErrorCategory, pub error_code: PixelflowStringView, pub message: PixelflowStringView, pub reserved: [usize; 4], }
Expand description

Structured ABI status returned by plugin and host callbacks.

Fields§

§size: u32

Struct size in bytes.

§version: u32

ABI version used by this struct.

§status_code: i32

Zero means success; non-zero means failure.

§category: PixelflowErrorCategory

Structured error category.

§error_code: PixelflowStringView

Stable dotted error code.

§message: PixelflowStringView

Human-readable message.

§reserved: [usize; 4]

Reserved fields for future compatible extension.

Implementations§

Source§

impl PixelflowStatus

Source

pub const fn ok() -> Self

Returns success status.

Source

pub const fn plugin_error(code: &'static str, message: &'static str) -> Self

Returns plugin failure status with static diagnostic strings.

Source

pub const fn is_ok(self) -> bool

Returns true when status is success.

Trait Implementations§

Source§

impl Clone for PixelflowStatus

Source§

fn clone(&self) -> PixelflowStatus

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 Debug for PixelflowStatus

Source§

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

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

impl PartialEq for PixelflowStatus

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Copy for PixelflowStatus

Source§

impl Eq for PixelflowStatus

Source§

impl StructuralPartialEq for PixelflowStatus

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.