Struct Failure 

pub struct Failure(/* private fields */);

A failure, as recorded and as returned to callers. One pointer wide (the fields are boxed), so a Result that may carry one stays small; it reads as its FailureData.

Implementations

impl Failure

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

A retryable failure with this message.

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

A failure that is never retried (FatalError in TypeScript, fusee.Fatal in Python).

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

Sets the type name.

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

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

pub fn retryable(self, retryable: bool) -> Self

false makes the failure final: no retry policy retries it.

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

Records a stack trace, cut to STACK_LIMIT bytes.

pub fn caused_by(self, cause: impl Into<Failure>) -> Self

pub fn is_retryable(&self) -> bool

Whether a retry policy may retry this failure (it was not marked final).

pub fn root(&self) -> &Failure

The innermost cause (this failure if it has none).

pub fn has_kind(&self, kind: &str) -> bool

Whether this failure, or one of its causes, has type kind.

pub fn to_payload(&self) -> Payload

The failure as it is recorded.

pub fn from_payload(p: &[u8]) -> Self

Reads a recorded failure: an envelope, or plain text as its message.

pub fn from_error(e: &(dyn Error + 'static), kind: Option<String>) -> Self

A failure from an error and its source chain. kind names the outermost error’s type.

Trait Implementations

impl Clone for Failure

fn clone(&self) -> Failure

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Failure

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

Formats the value using the given formatter.

impl Default for Failure

fn default() -> Failure

Returns the “default value” for a type.

impl Deref for Failure

type Target = FailureData

The resulting type after dereferencing.

fn deref(&self) -> &FailureData

Dereferences the value.

impl DerefMut for Failure

fn deref_mut(&mut self) -> &mut FailureData

Mutably dereferences the value.

impl<'de> Deserialize<'de> for Failure

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Failure

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

The message; {:#} adds each cause after a colon.

impl Error for Failure

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<&str> for Failure

fn from(message: &str) -> Self

Converts to this type from the input type.

impl From<Box<dyn Error + Sync + Send>> for Failure

fn from(e: Box<dyn Error + Send + Sync>) -> Self

Converts to this type from the input type.

impl From<Error> for Failure

fn from(e: Error) -> Self

Converts to this type from the input type.

impl From<Error> for Failure

fn from(e: Error) -> Self

Converts to this type from the input type.

impl From<Error> for Failure

fn from(e: Error) -> Self

Converts to this type from the input type.

impl From<Failure> for Error

fn from(f: Failure) -> Self

Converts to this type from the input type.

impl From<FailureData> for Failure

fn from(d: FailureData) -> Self

Converts to this type from the input type.

impl From<String> for Failure

fn from(message: String) -> Self

Converts to this type from the input type.

impl PartialEq for Failure

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Failure

impl StructuralPartialEq for Failure