Skip to main content

ErrorCode

Enum ErrorCode

#[non_exhaustive]pub enum ErrorCode {
Show 36 variants    InvalidRequest,
    Unauthorized,
    PermissionDenied,
    ContentTooLarge,
    NotSupported,
    RouteNotFound,
    MethodNotAllowed,
    NamespaceNotFound,
    NamespaceDeleted,
    NamespaceExists,
    ContentNotPrepared,
    PathNotFound,
    RevisionNotFound,
    PathConflict,
    DirectoryNotEmpty,
    StaleHead,
    StaleRevision,
    NotDeleted,
    WriterFenced,
    WouldCycle,
    CommitIdReuseConflict,
    CommitOutcomeUnknown,
    CommitQueueFull,
    ServerBusy,
    ShuttingDown,
    CheckpointUnavailable,
    MaintenanceRequired,
    UploadNotFound,
    UploadAlreadyCompleted,
    UploadContentConflict,
    RebootstrapRequired,
    QueryUnindexable,
    IndexLagging,
    IndexCorrupt,
    NamespaceCorrupt,
    ServerError,
}

Expand description

Stable machine-readable error reason.

This is the complete registry of code values carried by ApiError bodies and embedded errors. Codes are permanent once released: the API spec documents each code’s meaning and HTTP status, and clients must tolerate codes they do not recognize.

Variants (Non-exhaustive)§

This enum is marked as 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.

InvalidRequest

Carries the stable wire code invalid_request.

Unauthorized

Carries the stable wire code unauthorized.

PermissionDenied

Carries the stable wire code permission_denied.

ContentTooLarge

Carries the stable wire code content_too_large.

NotSupported

Carries the stable wire code not_supported.

RouteNotFound

Carries the stable wire code route_not_found.

MethodNotAllowed

Carries the stable wire code method_not_allowed.

NamespaceNotFound

Carries the stable wire code namespace_not_found.

NamespaceDeleted

Carries the stable wire code namespace_deleted.

NamespaceExists

Carries the stable wire code namespace_exists.

ContentNotPrepared

Carries the stable wire code content_not_prepared.

PathNotFound

Carries the stable wire code path_not_found.

RevisionNotFound

Carries the stable wire code revision_not_found.

PathConflict

Carries the stable wire code path_conflict.

DirectoryNotEmpty

Carries the stable wire code directory_not_empty.

StaleHead

Carries the stable wire code stale_head.

StaleRevision

Carries the stable wire code stale_revision.

NotDeleted

Carries the stable wire code not_deleted.

WriterFenced

Carries the stable wire code writer_fenced.

WouldCycle

Carries the stable wire code would_cycle.

CommitIdReuseConflict

Carries the stable wire code commit_id_reuse_conflict.

CommitOutcomeUnknown

Carries the stable wire code commit_outcome_unknown.

CommitQueueFull

Carries the stable wire code commit_queue_full.

ServerBusy

Carries the stable wire code server_busy.

ShuttingDown

Carries the stable wire code shutting_down.

CheckpointUnavailable

Carries the stable wire code checkpoint_unavailable.

MaintenanceRequired

Carries the stable wire code maintenance_required.

UploadNotFound

Carries the stable wire code upload_not_found.

UploadAlreadyCompleted

Carries the stable wire code upload_already_completed.

UploadContentConflict

Carries the stable wire code upload_content_conflict.

RebootstrapRequired

Carries the stable wire code rebootstrap_required.

QueryUnindexable

Carries the stable wire code query_unindexable.

IndexLagging

Carries the stable wire code index_lagging.

IndexCorrupt

Carries the stable wire code index_corrupt.

NamespaceCorrupt

Carries the stable wire code namespace_corrupt.

ServerError

Carries the stable wire code server_error.

Implementations§

impl ErrorCode

pub const ALL: [ErrorCode; 36]

Every registered code, in registry order.

pub fn as_str(self) -> &'static str

Returns the stable wire string for this code.

pub fn parse(value: &str) -> Option<ErrorCode>

Parses a registered code string, returning None for codes this build does not know (clients must tolerate those).

impl ErrorCode

pub fn kind(self) -> ErrorKind

Returns the caller-action category for this code.

The kind agrees with the HTTP status the api.md error table documents for the code; the server derives the served status from it.

Trait Implementations§

impl Clone for ErrorCode

fn clone(&self) -> ErrorCode

Returns a duplicate of the value. Read more

1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

impl Copy for ErrorCode

impl Debug for ErrorCode

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

Formats the value using the given formatter. Read more

impl<'de> Deserialize<'de> for ErrorCode

fn deserialize<D>( deserializer: D, ) -> Result<ErrorCode, <D as Deserializer<'de>>::Error>
where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

impl Display for ErrorCode

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

Formats the value using the given formatter. Read more

impl Eq for ErrorCode

impl PartialEq for ErrorCode

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

Equality operator ==. Read more

1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more

impl Serialize for ErrorCode

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more

impl StructuralPartialEq for ErrorCode

Auto Trait Implementations§

impl Freeze for ErrorCode

impl RefUnwindSafe for ErrorCode

impl Send for ErrorCode

impl Sync for ErrorCode

impl Unpin for ErrorCode

impl UnsafeUnpin for ErrorCode

impl UnwindSafe for ErrorCode

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

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

Performs copy-assignment from self to dest. Read more

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

impl<T> PolicyExt for T
where T: ?Sized,

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more

impl<T> Same for T

type Output = T

Should always be Self

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T> ToString for T
where T: Display + ?Sized,

fn to_string(&self) -> String

Converts the given value to a String. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more