Struct ffi_support::ErrorCode
source · #[repr(transparent)]pub struct ErrorCode(_);
Expand description
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.
Implementations
sourceimpl ErrorCode
impl ErrorCode
sourcepub const PANIC: ErrorCode = _
pub const PANIC: ErrorCode = _
The ErrorCode used for panics. It’s unlikely you need to ever use this.
sourcepub fn new(code: i32) -> Self
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).
sourcepub fn is_success(&self) -> bool
pub fn is_success(&self) -> bool
Returns whether or not this is a success code.
Trait Implementations
sourceimpl Ord for ErrorCode
impl Ord for ErrorCode
1.21.0 · sourcefn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere
Self: Sized,
Compares and returns the maximum of two values. Read more
1.21.0 · sourcefn min(self, other: Self) -> Selfwhere
Self: Sized,
fn min(self, other: Self) -> Selfwhere
Self: Sized,
Compares and returns the minimum of two values. Read more
1.50.0 · sourcefn clamp(self, min: Self, max: Self) -> Selfwhere
Self: Sized + PartialOrd<Self>,
fn clamp(self, min: Self, max: Self) -> Selfwhere
Self: Sized + PartialOrd<Self>,
Restrict a value to a certain interval. Read more
sourceimpl PartialOrd<ErrorCode> for ErrorCode
impl PartialOrd<ErrorCode> for ErrorCode
sourcefn partial_cmp(&self, other: &ErrorCode) -> Option<Ordering>
fn partial_cmp(&self, other: &ErrorCode) -> Option<Ordering>
1.0.0 · sourcefn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for
self
and other
) and is used by the <=
operator. Read moreimpl Copy for ErrorCode
impl Eq for ErrorCode
impl StructuralEq for ErrorCode
impl StructuralPartialEq for ErrorCode
Auto Trait Implementations
impl RefUnwindSafe for ErrorCode
impl Send for ErrorCode
impl Sync for ErrorCode
impl Unpin for ErrorCode
impl UnwindSafe for ErrorCode
Blanket Implementations
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more