Enum ErrorCategory 

#[non_exhaustive]
pub enum ErrorCategory {
    TransientServerFailure,
    ContentionOnSharedResources,
    DeadlineExceededRequestStateUnknown,
    SystemInternalAssumptionViolated,
    SecurityAlert,
    AuthInterceptorInvalidAuthenticationCredentials,
    InsufficientPermission,
    InvalidIndependentOfSystemState,
    InvalidGivenCurrentSystemStateOther,
    InvalidGivenCurrentSystemStateResourceExists,
    InvalidGivenCurrentSystemStateResourceMissing,
    InvalidGivenCurrentSystemStateSeekAfterEnd,
    InternalUnsupportedOperation,
}

Canton’s error categories — the coarse classification every Ledger API error carries (ErrorInfo.metadata["category"]), which the error-code documentation defines retryability on. #[non_exhaustive]: Canton may add categories.

The variants are the categories of the Canton 3.x docs, by their stable numeric ids (13 is a server-log-only warning that never reaches the API).

Variants (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.

TransientServerFailure

1 — a service was momentarily unavailable; the request may or may not have been processed. Retry with backoff.

ContentionOnSharedResources

2 — contention on shared resources (locks, rate limits, a locked contract). Retry with backoff.

DeadlineExceededRequestStateUnknown

3 — the request’s deadline expired with its outcome unknown. Retry a bounded number of times, relying on command deduplication.

SystemInternalAssumptionViolated

4 — a system-internal invariant was violated (implementation bug or data corruption). Not retriable; needs operator/vendor attention.

SecurityAlert

5 — a potential attack or faulty peer was detected; details are deliberately withheld. Not retriable.

AuthInterceptorInvalidAuthenticationCredentials

6 — missing or invalid authentication credentials. Not retriable until the credentials are fixed.

InsufficientPermission

7 — authenticated, but not permitted to perform the operation. Not retriable until permissions change.

InvalidIndependentOfSystemState

8 — the request is invalid regardless of system state (malformed arguments, size limits). Not retriable.

InvalidGivenCurrentSystemStateOther

9 — the current ledger state does not satisfy the request’s preconditions (Daml interpretation failures land here). Not blindly retriable; needs an application-level strategy.

InvalidGivenCurrentSystemStateResourceExists

10 — a referenced resource already exists (e.g. a duplicate command). Not retriable as-is.

InvalidGivenCurrentSystemStateResourceMissing

11 — a referenced resource does not exist (contract, package, party). Not retriable as-is.

InvalidGivenCurrentSystemStateSeekAfterEnd

12 — the request reads past the current ledger end. Retriable: the system may naturally progress to make it valid.

InternalUnsupportedOperation

14 — the operation is not implemented / not enabled on this node. Not retriable.

Implementations

impl ErrorCategory

pub const fn from_i32(id: i32) -> Option<ErrorCategory>

The category for Canton’s numeric id, None when unrecognized.

pub const fn as_i32(self) -> i32

Canton’s numeric id for this category.

pub const fn is_retriable(self) -> bool

Whether the error-code documentation classifies this category as retryable (transient failures, contention, unknown-outcome deadlines, and reads past the ledger end).

Trait Implementations

impl Clone for ErrorCategory

fn clone(&self) -> ErrorCategory

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ErrorCategory

impl Debug for ErrorCategory

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

Formats the value using the given formatter.

impl Eq for ErrorCategory

impl Hash for ErrorCategory

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

where __H: Hasher,

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 PartialEq for ErrorCategory

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ErrorCategory

impl TryFrom<i32> for ErrorCategory

The std spelling of ErrorCategory::from_i32, so the category can be used with generic conversion bounds. The inherent method stays: it is the documented name and the Option shape matches “unknown id” better than an error type would.

type Error = i32

The type returned in the event of a conversion error.

fn try_from(id: i32) -> Result<ErrorCategory, i32>

Performs the conversion.