Struct ffi_support::ErrorCode

#[repr(transparent)]
pub struct ErrorCode(_);

A wrapper around error codes, which is represented identically to an i32 on the other side of the FFI. Essentially exists to check that we don't accidentally reuse success/panic codes for other things.

Methods

impl ErrorCode

pub const SUCCESS: ErrorCode

The ErrorCode used for success.

pub const PANIC: ErrorCode

The ErrorCode used for panics. It's unlikely you need to ever use this.

pub const INVALID_HANDLE: ErrorCode

The ErrorCode used for handle map errors.

pub fn new(code: i32) -> Self

Construct an error code from an integer code.

Panics

Panics if you call it with 0 (reserved for success, but you can use ErrorCode::SUCCESS if that's what you want), or -1 (reserved for panics, but you can use ErrorCode::PANIC if that's what you want).

pub fn code(self) -> i32

Get the raw numeric value of this ErrorCode.

pub fn is_success(self) -> bool

Returns whether or not this is a success code.

Trait Implementations

impl PartialEq<ErrorCode> for ErrorCode

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Clone for ErrorCode

fn clone(&self) -> ErrorCode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for ErrorCode

fn default() -> ErrorCode

Returns the "default value" for a type.

impl PartialOrd<ErrorCode> for ErrorCode

fn partial_cmp(&self, other: &ErrorCode) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &ErrorCode) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &ErrorCode) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &ErrorCode) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &ErrorCode) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for ErrorCode

impl Ord for ErrorCode

fn cmp(&self, other: &ErrorCode) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl Copy for ErrorCode

impl Debug for ErrorCode

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

Formats the value using the given formatter.