Struct wasefire_board_api::Error

pub struct Error(/* private fields */);

API errors.

Errors are equivalent to u32 but only using the 24 least significant bits: 8 bits for the error space and 16 bits for the error code. The 8 most significant bits are zero. It is possible to encode a Result<u32, Error> into a i32 as long as the success value only uses the 31 least significant bits. Non-negative values encode success, while negative values encode the error by taking its bitwise complement (thus setting the 8 most significant bits to 1).

Implementations

impl Error

pub fn new(space: impl SpaceParam, code: impl CodeParam) -> Error

Creates a new error.

pub fn space(self) -> u8

Returns the error space.

pub fn code(self) -> u16

Returns the error code.

pub fn user(code: impl CodeParam) -> Error

Creates a user error.

pub fn internal(code: impl CodeParam) -> Error

Creates an internal error.

pub fn world(code: impl CodeParam) -> Error

Creates a world error.

pub fn decode(result: i32) -> Result<u32, Error>

Decodes a signed integer as a result (where errors are negative values).

Panics

Panics if the signed integer is smaller than -16777216 (0xff000000).

pub fn encode(result: Result<u32, Error>) -> i32

Encodes a result (where errors are negative values) as a signed integer.

Panics

Panics if the result is a success greater than 2147483647 (0x7fffffff).

pub fn check(self, cond: bool) -> Result<(), Error>

Ensures a condition is true, otherwise returns the error.

Trait Implementations

impl Clone for Error

fn clone(&self) -> Error

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Error

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

Formats the value using the given formatter.

impl Default for Error

fn default() -> Error

Returns the “default value” for a type.

impl Display for Error

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

Formats the value using the given formatter.

impl Hash for Error

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Error

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Error

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Error

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

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

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

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

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

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

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

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

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

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

impl Copy for Error

impl Eq for Error

impl StructuralPartialEq for Error