Struct WireError 

pub struct WireError {
    pub code: WireErrorCode,
    pub message: String,
    pub error_type: Option<String>,
}

Wire-safe error value. code is stable; message is informational only.

Fields

code: WireErrorCode

Stable client-branchable error code.

message: String

Human-readable informational message.

error_type: Option<String>

Concrete typed error variant, when the server can expose one safely.

Implementations

impl WireError

pub fn new(code: WireErrorCode, message: impl Into<String>) -> Self

Creates a wire error with the supplied stable code and informational message.

pub fn with_error_type(self, error_type: impl Into<String>) -> Self

Attach a concrete typed error variant name to this wire error.

pub fn with_optional_error_type(self, error_type: Option<String>) -> Self

Attach an optional concrete typed error variant name to this wire error.

pub fn new_with_type( code: WireErrorCode, error_type: impl Into<String>, message: impl Into<String>, ) -> Self

Creates a wire error with a concrete typed error variant name.

pub fn not_found(message: impl Into<String>) -> Self

Not-found failure.

pub fn namespace_denied(message: impl Into<String>) -> Self

Namespace authorization failure.

pub fn sequence_conflict(message: impl Into<String>) -> Self

Durable sequence conflict failure.

pub fn unknown_query(message: impl Into<String>) -> Self

Unknown workflow query failure.

pub fn query_timeout(message: impl Into<String>) -> Self

Query timeout failure.

pub fn not_running(message: impl Into<String>) -> Self

Workflow not-running failure.

pub fn lagged(message: impl Into<String>) -> Self

Lagged stream failure.

pub fn invalid_input(message: impl Into<String>) -> Self

Invalid input failure.

pub fn backend(message: impl Into<String>) -> Self

Backend/internal failure.

pub fn query_failed(message: impl Into<String>) -> Self

Query-handler application-level failure.

pub fn deploy_denied(message: impl Into<String>) -> Self

Deploy authorization failure.

pub fn version_pinned(message: impl Into<String>) -> Self

Deploy version-pinned refusal.

pub fn not_found_with_type( error_type: impl Into<String>, message: impl Into<String>, ) -> Self

Not-found failure with a concrete typed error variant name.

pub fn not_running_with_type( error_type: impl Into<String>, message: impl Into<String>, ) -> Self

Not-running failure with a concrete typed error variant name.

pub fn backend_with_type( error_type: impl Into<String>, message: impl Into<String>, ) -> Self

Backend/internal failure with a concrete typed error variant name.

Trait Implementations

impl Clone for WireError

fn clone(&self) -> WireError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WireError

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for WireError

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for WireError

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

Formats the value using the given formatter.

impl Eq for WireError

impl Error for WireError

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<WireError> for ProtoWireError

fn from(value: WireError) -> Self

Converts to this type from the input type.

impl PartialEq for WireError

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for WireError

impl TryFrom<ProtoWireError> for WireError

type Error = WireError

The type returned in the event of a conversion error.

fn try_from(value: ProtoWireError) -> Result<Self, Self::Error>

Performs the conversion.