Enum Error 

pub enum Error {
    Auth(String),
    PermissionDenied {
        message: String,
        status: u16,
        code: String,
        context: String,
        endpoint: String,
    },
    Validation(String),
    Transport(String),
    ResponseContract {
        context: String,
        message: String,
    },
    RateLimit {
        message: String,
        retry_after: Option<f64>,
    },
    Server(String),
    Api {
        message: String,
        code: String,
        metadata: Vec<(String, String)>,
    },
    RouteNotFound {
        procedure: String,
    },
    Realtime(String),
    QueueOverflow(String),
}

Polyester SDK error.

Variants

Auth(String)

PermissionDenied

Fields

message: String

status: u16

code: String

context: String

endpoint: String

Validation(String)

Transport(String)

ResponseContract

A successful RPC returned a payload that violates the documented response contract.

This is not retryable: repeating a mutation blindly can duplicate work. Because the server may already have accepted the mutation, callers must reconcile when Self::mutation_outcome_unknown returns true.

Fields

context: String

message: String

RateLimit

Fields

message: String

retry_after: Option<f64>

Server(String)

Api

Fields

message: String

code: String

metadata: Vec<(String, String)>

RouteNotFound

Fields

procedure: String

Realtime(String)

QueueOverflow(String)

Realtime subscription queue was full; the subscription fails instead of silently dropping updates.

Implementations

impl Error

pub fn auth(msg: impl Into<String>) -> Self

pub fn validation(msg: impl Into<String>) -> Self

pub fn transport(msg: impl Into<String>) -> Self

pub fn response_contract( context: impl Into<String>, message: impl Into<String>, ) -> Self

pub fn realtime(msg: impl Into<String>) -> Self

pub fn queue_overflow(msg: impl Into<String>) -> Self

pub fn is_retryable(&self) -> bool

Whether retrying may succeed after backoff.

This is a transport-level classification, not a guarantee that a mutation was not applied. For mutations, preserve the same idempotency key and reconcile server state before retrying when Self::mutation_outcome_unknown is true.

pub fn mutation_outcome_unknown(&self) -> bool

Whether this error can occur after the server accepted a mutation.

Callers must treat these failures as ambiguous: reconcile first and reuse the original idempotency key if a retry is necessary.

pub fn retry_after(&self) -> Option<f64>

Server-requested retry delay in seconds, when supplied.

pub fn auth_error_code(&self) -> Option<&str>

Structured auth.v1.AuthErrorDetail code when this is an Error::Api.

pub fn is_mfa_enrollment_required(&self) -> bool

True when the caller must enroll an MFA factor before continuing.

pub fn is_step_up_required(&self) -> bool

True when the caller must retry with a fresh X-Auth-Step-Up proof.

pub fn is_mfa_elevation_required(&self) -> bool

True when the caller needs a recent MFA-elevated interactive session.

pub fn is_mfa_last_factor_required(&self) -> bool

True when the final active MFA factor cannot be removed.

Trait Implementations

impl Clone for Error

fn clone(&self) -> Error

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

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

Provides type-based access to context intended for error reports.