Enum Code

#[non_exhaustive]
#[repr(u16)]
pub enum Code {
    Generic = 0,
    NotImplemented = 1,
    NotFound = 2,
    InvalidLength = 3,
    InvalidAlign = 4,
    NoPermission = 5,
    NotEnough = 6,
    InvalidState = 7,
    InvalidArgument = 8,
    OutOfBounds = 9,
}

Common error codes.

Values from 0 to 32767 (0x7fff) are reserved for common error codes and defined by this enum. Values from 32768 (0x8000) to 65535 (0xffff) are reserved for implementation-specific error codes.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Generic = 0

NotImplemented = 1

The operation is not implemented.

NotFound = 2

An input was not found.

InvalidLength = 3

An input has an invalid length.

InvalidAlign = 4

An input has an invalid alignment.

NoPermission = 5

The caller does not have permission for the operation.

NotEnough = 6

There is not enough resource for the operation.

InvalidState = 7

An input is invalid for the current state.

This could also be that the current state is invalid for all inputs and cannot progress anymore.

InvalidArgument = 8

An input is invalid.

This is a generic error. More precise errors would be InvalidLength, InvalidAlign, InvalidState, or NotFound for example.

OutOfBounds = 9

An input is out of bounds.

Trait Implementations

impl Clone for Code

fn clone(&self) -> Code

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Code

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

Formats the value using the given formatter.

impl From<Code> for u16

fn from(enum_value: Code) -> Self

Converts to this type from the input type.

impl TryFrom<u16> for Code

type Error = TryFromPrimitiveError<Code>

The type returned in the event of a conversion error.

fn try_from(number: u16) -> Result<Self, TryFromPrimitiveError<Self>>

Performs the conversion.

impl TryFromPrimitive for Code

const NAME: &'static str = "Code"

type Primitive = u16

type Error = TryFromPrimitiveError<Code>

fn try_from_primitive( number: Self::Primitive, ) -> Result<Self, TryFromPrimitiveError<Self>>

impl CodeParam for Code

impl Copy for Code