Enum ApiErrorCode 

pub enum ApiErrorCode {
    NotFound,
    Unauthorized,
    BadRequest,
    Conflict,
    VisibilityLocked,
    InternalError,
}

Closed set of error codes the API can emit. Renders as a snake_case string on the wire (not_found, unauthorized, …) and is declared as an OpenAPI enum so generated clients can switch on it exhaustively. Add a variant here, never a free-form string in the code field of ApiErrorResponse.

JSON schema

{
 "description": "Closed set of error codes the API can emit. Renders as a snake_case\nstring on the wire (`not_found`, `unauthorized`, …) and is declared\nas an OpenAPI enum so generated clients can switch on it\nexhaustively. Add a variant here, never a free-form string in\nthe `code` field of `ApiErrorResponse`.",
 "type": "string",
 "enum": [
   "not_found",
   "unauthorized",
   "bad_request",
   "conflict",
   "visibility_locked",
   "internal_error"
 ]
}

Variants

NotFound

Unauthorized

BadRequest

Conflict

VisibilityLocked

InternalError

Trait Implementations

impl Clone for ApiErrorCode

fn clone(&self) -> ApiErrorCode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ApiErrorCode

impl Debug for ApiErrorCode

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ApiErrorCode

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ApiErrorCode

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

Formats the value using the given formatter.

impl Eq for ApiErrorCode

impl FromStr for ApiErrorCode

type Err = ConversionError

The associated error which can be returned from parsing.

fn from_str(value: &str) -> Result<Self, ConversionError>

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

impl Hash for ApiErrorCode

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 ApiErrorCode

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

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

fn partial_cmp(&self, other: &ApiErrorCode) -> 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 Serialize for ApiErrorCode

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ApiErrorCode

impl TryFrom<&String> for ApiErrorCode

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: &String) -> Result<Self, ConversionError>

Performs the conversion.

impl TryFrom<&str> for ApiErrorCode

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<Self, ConversionError>

Performs the conversion.

impl TryFrom<String> for ApiErrorCode

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: String) -> Result<Self, ConversionError>

Performs the conversion.