Enum Code 

#[non_exhaustive]
#[repr(u32)]
pub enum Code {
    Ok = 0,
    ShapeMismatch = 1,
    Locked = 2,
    Busy = 3,
    NotFound = 4,
    WrongType = 5,
    AbiMismatch = 6,
    Corrupt = 7,
    Full = 8,
    Io = 9,
    Unsupported = 10,
    Invalid = 11,
    EpochStalled = 12,
    VersionTooNew = 13,
}

A stable, wire visible condition code.

These numbers are frozen once released. They are the same integers the C ABI exposes as yo_code and the same ones every binding reports.

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.

Ok = 0

Not an error. Present so that the C enum has a zero value that means success.

C name: YO_OK.

ShapeMismatch = 1

The type used to open a collection does not match the type the collection was created with. The message carries both shape descriptions in full, not just the tags.

C name: YO_ERR_SHAPE_MISMATCH.

Locked = 2

Another process holds the writer lock on this file. Exactly one writer per file.

C name: YO_ERR_LOCKED.

Busy = 3

The handle has live children. Closing a parent with live children closes nothing.

C name: YO_ERR_BUSY.

NotFound = 4

The key, field, member or node does not exist. This is a value and not a failure, and the typed API returns an Option rather than this error wherever it can.

C name: YO_ERR_NOT_FOUND.

WrongType = 5

The key holds a different data structure than the operation expects. This is Redis WRONGTYPE.

C name: YO_ERR_WRONG_TYPE.

AbiMismatch = 6

The header the caller compiled against and the library it loaded disagree. The message names both versions.

C name: YO_ERR_ABI_MISMATCH.

Corrupt = 7

A checksum failed or a structure is self-inconsistent. The message names the offset and what was expected there.

C name: YO_ERR_CORRUPT.

Full = 8

A bounded resource is exhausted: the address space, a fixed table, or a configured memory limit.

C name: YO_ERR_FULL.

Io = 9

The operating system refused an operation. The detail field carries errno and the path.

C name: YO_ERR_IO.

Unsupported = 10

The operation is valid but this build or this platform does not implement it. The message says which build would.

C name: YO_ERR_UNSUPPORTED.

Invalid = 11

The arguments are wrong. The position field points at which one.

C name: YO_ERR_INVALID.

EpochStalled = 12

An iterator has been open long enough to hold back reclamation. Finish it or drop it. The message carries the iterator age in microseconds.

C name: YO_ERR_EPOCH_STALLED.

VersionTooNew = 13

The file’s min_reader_version is higher than this build supports. The message names both numbers and the release that would read it.

C name: YO_ERR_VERSION_TOO_NEW.

Implementations

impl Code

pub const ALL: &'static [Code]

Every code, in wire order. Index equals the numeric value.

pub const fn as_u32(self) -> u32

The wire value.

pub const fn from_u32(v: u32) -> Option<Code>

The code for a wire value, or None if this build does not know it.

An unknown code from a newer peer is a value to report, not a panic.

pub const fn c_name(self) -> &'static str

The C ABI spelling, which is also what appears in log lines.

pub const fn is_retryable(self) -> bool

Whether the identical call could succeed later.

This is a property of the condition and not of the caller, which is why it is generated rather than decided at each call site.

pub const fn c_name_z(self) -> &'static str

The C ABI spelling with a trailing NUL, ready to cross the boundary.

The C ABI needs NUL terminated strings and Rust literals are not, so the terminator is put here where it is generated rather than in a second table somebody has to keep in step by hand.

pub const fn url_z(self) -> Option<&'static str>

The documentation page with a trailing NUL, if there is one.

pub const fn url(self) -> Option<&'static str>

The documentation page for this condition, if it has one.

Trait Implementations

impl Clone for Code

fn clone(&self) -> Code

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Code

impl Debug for Code

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

Formats the value using the given formatter.

impl Eq for Code

impl Hash for Code

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 Code

fn cmp(&self, other: &Code) -> 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,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for Code

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Code

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl StructuralPartialEq for Code