Enum ErrorCode

pub enum ErrorCode {
    InternalEngine,
    InternalApi,
    BadRequest,
    AuthTokenMissing,
    AuthTokenInvalid,
    InvalidJson,
    InvalidBson,
    WrongProtocol,
    ConnectionProblem,
    MessageTypeNotAccepted,
    MessageTypeNotAcceptedForWebRTC,
}

The type of error sent by the KittyCAD API.

Variants

InternalEngine

Graphics engine failed to complete request, consider retrying

InternalApi

API failed to complete request, consider retrying

BadRequest

User requested something geometrically or graphically impossible. Don’t retry this request, as it’s inherently impossible. Instead, read the error message and change your request.

AuthTokenMissing

Auth token is missing from the request

AuthTokenInvalid

Auth token is invalid in some way (expired, incorrect format, etc)

InvalidJson

Client sent invalid JSON.

InvalidBson

Client sent invalid BSON.

WrongProtocol

Client sent a message which is not accepted over this protocol.

ConnectionProblem

Problem sending data between client and KittyCAD API.

MessageTypeNotAccepted

Client sent a Websocket message type which the KittyCAD API does not handle.

MessageTypeNotAcceptedForWebRTC

Client sent a Websocket message intended for WebRTC but it was configured as a WebRTC connection.

Trait Implementations

impl Clone for ErrorCode

fn clone(&self) -> ErrorCode

Returns a copy 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<'de> Deserialize<'de> for ErrorCode

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ErrorCode

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

Formats the value using the given formatter.

impl From<EngineErrorCode> for ErrorCode

Because EngineErrorCode is a subset of ErrorCode, you can trivially map each variant of the former to a variant of the latter.

fn from(value: EngineErrorCode) -> Self

Converts to this type from the input type.

impl FromStr for ErrorCode

type Err = ParseError

The associated error which can be returned from parsing.

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

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

impl JsonSchema for ErrorCode

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

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 Serialize for ErrorCode

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for ErrorCode

impl Eq for ErrorCode

impl StructuralPartialEq for ErrorCode