Enum lexical_core::ErrorCode

#[repr(i32)]
pub enum ErrorCode {
    Success,
    Overflow,
    InvalidDigit,
    Empty,
    // some variants omitted
}

Error code, indicating success or failure.

Success, or no error, is 0, while error messages are designating by an error code of less than 0. This is to be compatible with C conventions.

FFI

For interfacing with FFI-code, this may be approximated by:

const int32_t SUCCESS = 0;
const int32_t OVERFLOW = -1;
const int32_t INVALID_DIGIT = -2;
const int32_t EMPTY = -3;

Safety

Assigning any value outside the range [-3, 0] to value of type ErrorCode may invoke undefined-behavior.

Variants

Success

No error, success.

Overflow

Integral overflow occurred during numeric parsing.

Numeric overflow takes precedence over the presence of an invalid digit.

InvalidDigit

Invalid digit found before string termination.

Empty

Empty byte array found.

Trait Implementations

impl Clone for ErrorCode

fn clone(&self) -> ErrorCode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for ErrorCode

impl Debug for ErrorCode

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

Formats the value using the given formatter.

impl Eq for ErrorCode

impl Ord for ErrorCode

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

This method returns an Ordering between self and other.

#[must_use]

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

Compares and returns the maximum of two values.

#[must_use]

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

Compares and returns the minimum of two values.

#[must_use]

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

Restrict a value to a certain interval.

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

#[must_use]

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

This method tests for !=.

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.

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

pub 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 StructuralEq for ErrorCode

impl StructuralPartialEq for ErrorCode