Struct ServiceError 

pub struct ServiceError {
    pub code: String,
    pub message: String,
    pub retryable: bool,
    pub details: Option<Value>,
}

Typed wire error. retryable means resubmitting the request can succeed.

Equality compares code, message, retryable and details.

Fields

code: String

message: String

retryable: bool

details: Option<Value>

Optional structured data (e.g. the platform of a needs_auth). Absent or null on the wire reads as None; written only when present, so older peers see the frame they always saw. Set with ServiceError::with_details, read with ServiceError::details.

Implementations

impl ServiceError

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

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

pub fn with_details(self, details: Value) -> Self

Attaches structured details; Value::Null clears them.

pub fn details(&self) -> Option<&Value>

Structured data attached with ServiceError::with_details, or None.

pub fn handoff() -> Self

pub fn to_value(&self) -> Value

pub fn from_value(v: &Value) -> Self

Trait Implementations

impl Clone for ServiceError

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ServiceError

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

Formats the value using the given formatter.

impl Display for ServiceError

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

Formats the value using the given formatter.

impl Eq for ServiceError

impl Error for ServiceError

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<Error> for ServiceError

fn from(e: Error) -> Self

Converts to this type from the input type.

impl From<HostIdentityError> for ServiceError

fn from(e: HostIdentityError) -> Self

The wire-style form of a host identity refusal: code ERROR_HOST_IDENTITY, not retryable.

impl From<ServiceError> for ConnectError

fn from(e: ServiceError) -> Self

Converts to this type from the input type.

impl PartialEq for ServiceError

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ServiceError