Enum ErrorCode

pub enum ErrorCode {
    Other = 10_000,
    NotALeader = 10_001,
    StorageCorrupted = 10_002,
    TermMismatch = 10_003,
    RaftLogUnavailable = 10_004,
    RaftLogCompacted = 10_005,
    CasNoSuchRaftIndex = 10_006,
    CasConflictFound = 10_007,
    CasEntryTermMismatch = 10_008,
    CasTableNotAllowed = 10_009,
    CasInvalidOpKind = 10_010,
    NoSuchService = 10_011,
    ServiceNotStarted = 10_012,
    ServicePoisoned = 10_013,
    ServiceNotAvailable = 10_014,
    WrongPluginVersion = 10_015,
    NoSuchInstance = 10_016,
    NoSuchReplicaset = 10_017,
    LeaderUnknown = 10_018,
    PluginError = 10_019,
    InstanceExpelled = 10_020,
    ReplicasetExpelled = 10_021,
    InstanceUnavaliable = 10_022,
    CasTableNotOperable = 10_023,
    Uninitialized = 10_024,
    ExpelNotAllowed = 10_025,
    CasConfigNotAllowed = 10_026,
    RaftProposalDropped = 10_027,
    SbroadError = 10_028,
    RaftSnapshotReadViewNotAvailable = 10_029,
    UserDefinedErrorCodesStart = 20_000,
}

Error codes used with BoxError which are only generated by picodata.

Variants

Other = 10_000

This is the first picodata error code. Use this for errors which are hard to categorize and for which there’s no specific way of handling.

Also please use a unique error message for these kinds of errors, so it’s easy to find where it was generated in code.

If your error instead should be handled in a specific way please add a new one if the existing ones don’t satisfy your needs.

NotALeader = 10_001

Requested instance is not a leader.

StorageCorrupted = 10_002

Contents of a builtin table has invalid format.

TermMismatch = 10_003

Operation request from different term.

RaftLogUnavailable = 10_004

Raft log is temporarily unavailable.

RaftLogCompacted = 10_005

Can’t check the predicate because raft log is compacted.

CasNoSuchRaftIndex = 10_006

Nearly impossible error indicating invalid request.

CasConflictFound = 10_007

Checking the predicate revealed a collision.

CasEntryTermMismatch = 10_008

Request expected raft entry to have a different term.

CasTableNotAllowed = 10_009

SpaceNotAllowed: space {space} is prohibited for use in a predicate

CasInvalidOpKind = 10_010

Unexpected traft operation kind.

NoSuchService = 10_011

ServiceNotStarted = 10_012

ServicePoisoned = 10_013

ServiceNotAvailable = 10_014

WrongPluginVersion = 10_015

NoSuchInstance = 10_016

NoSuchReplicaset = 10_017

LeaderUnknown = 10_018

PluginError = 10_019

InstanceExpelled = 10_020

ReplicasetExpelled = 10_021

InstanceUnavaliable = 10_022

CasTableNotOperable = 10_023

TableNotOperable: table {table} is prohibited for use in a predicate

Uninitialized = 10_024

Picodata machinery is not yet initialized on the instance.

ExpelNotAllowed = 10_025

Instance is not allowed to be expelled in the given situation for some reason. The most often solution is to use picodata expel --force.

CasConfigNotAllowed = 10_026

TableNotOperable: table {table} is prohibited for use in a predicate

RaftProposalDropped = 10_027

Raft proposal was dropped by the leader.

SbroadError = 10_028

Generic sbroad error

RaftSnapshotReadViewNotAvailable = 10_029

A raft snapshot read view is not available.

UserDefinedErrorCodesStart = 20_000

Not an actual error code, just designates the start of the range.

Implementations

impl ErrorCode

pub const VARIANTS: &'static [Self]

A slice of all possible enum variants.

These are ordered in the order of definition in the source code.

pub const MIN: Self

The enum variant with the smallest discriminant.

pub const MAX: Self

The enum variant with the largest discriminant.

pub const DISCRIMINANTS_ARE_SUBSEQUENT: bool = false

If this is true then all of the enum variants have subsequent discriminants and converting from integer to enum type is going to use a more efficient implementation.

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

Returns the name of the variant as it is spelled in the source code.

pub const fn from_i64(n: i64) -> Option<Self>

Converts integer to enum.

Returns None if no variant of the enum has the corresponding discriminant.

impl ErrorCode

pub fn is_retriable_for_cas(&self) -> bool

These types of errors signify different kinds of conflicts which can occur during a compare_and_swap RPC request. If such an error happens it’s safe to retry the request under the following conditions:

• The raft read index operation is performed before each retry
• The preconditions of the request are checked before each retry
• The request is generated before each retry with an up to date raft index

Trait Implementations

impl Clone for ErrorCode

fn clone(&self) -> ErrorCode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ErrorCode

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

Formats the value using the given formatter.

impl From<ErrorCode> for u32

fn from(code: ErrorCode) -> u32

Converts to this type from the input type.

impl Hash for ErrorCode

fn hash<__H: Hasher>(&self, state: &mut __H)

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 ErrorCode

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

impl PartialEq for ErrorCode

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for ErrorCode

fn partial_cmp(&self, other: &ErrorCode) -> 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 TryFrom<i16> for ErrorCode

type Error = i16

The type returned in the event of a conversion error.

fn try_from(n: i16) -> Result<Self, i16>

Performs the conversion.

impl TryFrom<i32> for ErrorCode

type Error = i32

The type returned in the event of a conversion error.

fn try_from(n: i32) -> Result<Self, i32>

Performs the conversion.

impl TryFrom<i64> for ErrorCode

type Error = i64

The type returned in the event of a conversion error.

fn try_from(n: i64) -> Result<Self, i64>

Performs the conversion.

impl TryFrom<i8> for ErrorCode

type Error = i8

The type returned in the event of a conversion error.

fn try_from(n: i8) -> Result<Self, i8>

Performs the conversion.

impl TryFrom<isize> for ErrorCode

type Error = isize

The type returned in the event of a conversion error.

fn try_from(n: isize) -> Result<Self, isize>

Performs the conversion.

impl TryFrom<u16> for ErrorCode

type Error = u16

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<u32> for ErrorCode

type Error = u32

The type returned in the event of a conversion error.

fn try_from(n: u32) -> Result<Self, u32>

Performs the conversion.

impl TryFrom<u64> for ErrorCode

type Error = u64

The type returned in the event of a conversion error.

fn try_from(n: u64) -> Result<Self, u64>

Performs the conversion.

impl TryFrom<u8> for ErrorCode

type Error = u8

The type returned in the event of a conversion error.

fn try_from(n: u8) -> Result<Self, u8>

Performs the conversion.

impl TryFrom<usize> for ErrorCode

type Error = usize

The type returned in the event of a conversion error.

fn try_from(n: usize) -> Result<Self, usize>

Performs the conversion.

impl Copy for ErrorCode

impl Eq for ErrorCode

impl StructuralPartialEq for ErrorCode