Skip to main content

RKRStatus

Enum RKRStatus 

Source
#[repr(C)]
pub enum RKRStatus { RKR_STATUS_SUCCESS = 0, RKR_STATUS_NULL_POINTER = -1, RKR_STATUS_INVALID_UTF8 = -2, RKR_STATUS_INVALID_JSON = -3, RKR_STATUS_IO_ERROR = -4, RKR_STATUS_INDEX_OUT_OF_BOUNDS = -5, RKR_STATUS_BUFFER_TOO_SMALL = -6, RKR_STATUS_INTERNAL_ERROR = -7, RKR_STATUS_SECTION_ABSENT = -8, RKR_STATUS_VALIDATION_ERROR = -9, RKR_STATUS_SELECTION_ERROR = -10, RKR_STATUS_FEATURE_DISABLED = -11, }
Expand description

Error codes for RKR functions.

Variants§

§

RKR_STATUS_SUCCESS = 0

Function completed successfully.

§

RKR_STATUS_NULL_POINTER = -1

A null pointer was passed for a required argument.

§

RKR_STATUS_INVALID_UTF8 = -2

An input string was not valid UTF-8.

§

RKR_STATUS_INVALID_JSON = -3

JSON parsing or serialization failed.

§

RKR_STATUS_IO_ERROR = -4

File I/O error.

§

RKR_STATUS_INDEX_OUT_OF_BOUNDS = -5

Index out of bounds.

§

RKR_STATUS_BUFFER_TOO_SMALL = -6

The destination buffer cannot hold a null-terminated string.

§

RKR_STATUS_INTERNAL_ERROR = -7

An internal logic error or unhandled state.

§

RKR_STATUS_SECTION_ABSENT = -8

An optional section (velocities, forces, atom_energies) was requested but is not declared on the builder.

§

RKR_STATUS_VALIDATION_ERROR = -9

DLPack export or another validation step failed.

§

RKR_STATUS_SELECTION_ERROR = -10

Chemfiles selection parse/evaluate failed (requires chemfiles-enabled build).

§

RKR_STATUS_FEATURE_DISABLED = -11

Requested API is not in this build (Cargo feature off / symbols omitted). Never use -7 for this — that is [RKR_STATUS_INTERNAL_ERROR].

Trait Implementations§

Source§

impl Debug for RKRStatus

Source§

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

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

impl Eq for RKRStatus

Source§

impl PartialEq for RKRStatus

Source§

fn eq(&self, other: &RKRStatus) -> 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 StructuralPartialEq for RKRStatus

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> 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, 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.