Struct PublicError 

pub struct PublicError { /* private fields */ }

A failure safe to display, serialize, or map at a public transport boundary.

This type cannot carry arbitrary messages or an error source. Construction is restricted to named constructors so its kind and details cannot disagree. The optional incident identifier is an opaque correlation value, not a diagnostic.

Implementations

impl PublicError

pub const fn validation(issues: ValidationIssues) -> PublicError

Creates a bounded validation failure.

pub const fn idempotency_key_reuse() -> PublicError

Creates an idempotency-key-reuse failure.

pub const fn authorization_denied() -> PublicError

Creates an authorization-denied failure.

pub const fn concurrency_deadline_exceeded() -> PublicError

Creates the shared failure for a logical-conflict deadline or exhausted fixed v1 command reevaluation budget.

pub const fn contract_mismatch( active_contract_version: ContractVersion, ) -> PublicError

Creates a contract mismatch and identifies the active version.

pub const fn storage_unavailable() -> PublicError

Creates a storage-unavailable failure.

pub const fn outcome_unknown() -> PublicError

Creates an uncertain-outcome failure.

pub const fn command_execution_failed(code: ExecutionFailureCode) -> PublicError

Creates a deterministic command-execution failure.

pub const fn internal_defect(incident_id: IncidentId) -> PublicError

Creates a redacted internal-defect failure with its incident identifier.

pub const fn history_incarnation_mismatch() -> PublicError

Creates a history-incarnation mismatch failure.

pub const fn history_pruned() -> PublicError

Creates a history-pruned failure (RDB-HISTORY-0102).

pub const fn follower_mode() -> PublicError

Creates the typed follower-mode refusal before any write is admitted.

pub const fn primary_fenced() -> PublicError

Creates the durable primary-fence refusal before command admission. This outcome never recommends retrying or clearing the fence.

pub const fn overloaded() -> PublicError

Creates an overload / capacity rejection failure.

pub const fn with_incident_id(self, incident_id: IncidentId) -> PublicError

Adds an opaque incident identifier for trusted diagnostic correlation.

pub fn with_application_code_hint( self, code: ApplicationErrorCode, ) -> Result<PublicError, ApplicationErrorHintError>

Attaches a stricter symbolic classification for the application surface.

The compatible kernel serializer deliberately ignores this hint.

pub const fn application_code_hint(&self) -> Option<ApplicationErrorCode>

Returns the stricter application-only classification, when present.

pub const fn kind(&self) -> PublicErrorKind

Returns the closed failure kind.

pub const fn code(&self) -> &'static str

Returns the stable public code.

pub const fn safe_message(&self) -> &'static str

Returns the stable public-safe message.

pub const fn class(&self) -> ErrorClass

Returns the protocol-neutral failure class.

pub const fn status_code(&self) -> PublicErrorStatusCode

Returns the authoritative public status code for this error.

pub const fn recovery_action(&self) -> RecoveryAction

Returns safe recovery guidance.

pub const fn details(&self) -> &PublicErrorDetails

Returns structured, caller-safe detail for this failure.

pub const fn incident_id(&self) -> Option<&IncidentId>

Returns the opaque incident identifier, when one is available.

Trait Implementations

impl Clone for PublicError

fn clone(&self) -> PublicError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PublicError

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

Formats the value using the given formatter.

impl Display for PublicError

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

Formats the value using the given formatter.

impl Eq for PublicError

impl Error for PublicError

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.

impl From<InternalError> for PublicError

fn from(error: InternalError) -> PublicError

Converts to this type from the input type.

impl PartialEq for PublicError

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