Enum StatusCode

pub enum StatusCode {
    Success = 0,
    Unknown = 1_000,
    Unsupported = 1_001,
    Unexpected = 1_002,
    Internal = 1_003,
    InvalidArguments = 1_004,
    Cancelled = 1_005,
    IllegalState = 1_006,
    External = 1_007,
    InvalidSyntax = 2_000,
    PlanQuery = 3_000,
    EngineExecuteQuery = 3_001,
    TableAlreadyExists = 4_000,
    TableNotFound = 4_001,
    TableColumnNotFound = 4_002,
    TableColumnExists = 4_003,
    DatabaseNotFound = 4_004,
    RegionNotFound = 4_005,
    RegionAlreadyExists = 4_006,
    RegionReadonly = 4_007,
    RegionNotReady = 4_008,
    RegionBusy = 4_009,
    TableUnavailable = 4_010,
    DatabaseAlreadyExists = 4_011,
    StorageUnavailable = 5_000,
    RequestOutdated = 5_001,
    RuntimeResourcesExhausted = 6_000,
    RateLimited = 6_001,
    UserNotFound = 7_000,
    UnsupportedPasswordType = 7_001,
    UserPasswordMismatch = 7_002,
    AuthHeaderNotFound = 7_003,
    InvalidAuthHeader = 7_004,
    AccessDenied = 7_005,
    PermissionDenied = 7_006,
    FlowAlreadyExists = 8_000,
    FlowNotFound = 8_001,
}

Common status code for public API.

Variants

Success = 0

Success.

Unknown = 1_000

Unknown error.

Unsupported = 1_001

Unsupported operation.

Unexpected = 1_002

Unexpected error, maybe there is a BUG.

Internal = 1_003

Internal server error.

InvalidArguments = 1_004

Invalid arguments.

Cancelled = 1_005

The task is cancelled.

IllegalState = 1_006

Illegal state, can be exposed to users.

External = 1_007

Caused by some error originated from external system.

InvalidSyntax = 2_000

SQL Syntax error.

PlanQuery = 3_000

Fail to create a plan for the query.

EngineExecuteQuery = 3_001

The query engine fail to execute query.

TableAlreadyExists = 4_000

Table already exists.

TableNotFound = 4_001

Table not found.

TableColumnNotFound = 4_002

Table column not found.

TableColumnExists = 4_003

Table column already exists.

DatabaseNotFound = 4_004

Database not found.

RegionNotFound = 4_005

Region not found.

RegionAlreadyExists = 4_006

Region already exists.

RegionReadonly = 4_007

Region is read-only in current state.

RegionNotReady = 4_008

Region is not in a proper state to handle specific request.

RegionBusy = 4_009

Region is temporarily in busy state.

TableUnavailable = 4_010

Table is temporarily unable to handle the request.

DatabaseAlreadyExists = 4_011

Database already exists.

StorageUnavailable = 5_000

Storage is temporarily unable to handle the request.

RequestOutdated = 5_001

Request is outdated, e.g., version mismatch.

RuntimeResourcesExhausted = 6_000

Runtime resources exhausted, like creating threads failed.

RateLimited = 6_001

Rate limit exceeded.

UserNotFound = 7_000

User not exist.

UnsupportedPasswordType = 7_001

Unsupported password type.

UserPasswordMismatch = 7_002

Username and password does not match.

AuthHeaderNotFound = 7_003

Not found http authorization header.

InvalidAuthHeader = 7_004

Invalid http authorization header.

AccessDenied = 7_005

Illegal request to connect catalog-schema.

PermissionDenied = 7_006

User is not authorized to perform the operation.

FlowAlreadyExists = 8_000

FlowNotFound = 8_001

Implementations

impl StatusCode

pub const fn from_repr(discriminant: usize) -> Option<StatusCode>

Try to create Self from the raw representation

impl StatusCode

pub fn is_success(code: u32) -> bool

Returns true if code is success.

pub fn is_retryable(&self) -> bool

Returns true if the error with this code is retryable.

pub fn should_log_error(&self) -> bool

Returns true if we should print an error log for an error with this status code.

pub fn from_u32(value: u32) -> Option<Self>

Trait Implementations

impl AsRef<str> for StatusCode

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for StatusCode

fn clone(&self) -> StatusCode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StatusCode

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

Formats the value using the given formatter.

impl Display for StatusCode

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

Formats the value using the given formatter.

impl FromStr for StatusCode

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<StatusCode, <Self as FromStr>::Err>

Parses a string s to return a value of this type.

impl IntoEnumIterator for StatusCode

type Iterator = StatusCodeIter

fn iter() -> StatusCodeIter

impl PartialEq for StatusCode

fn eq(&self, other: &StatusCode) -> 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 TryFrom<&str> for StatusCode

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<StatusCode, <Self as TryFrom<&str>>::Error>

Performs the conversion.

impl Copy for StatusCode

impl Eq for StatusCode

impl StructuralPartialEq for StatusCode