Skip to main content

Failure

Struct Failure 

Source
pub struct Failure {
    pub code: String,
    pub retryable: bool,
    pub message: String,
}
Expand description

A refused request: a stable code, whether retrying can help, and a message safe to hand back to the orchestrator.

retryable is the field an orchestrator actually branches on, so it is computed rather than guessed. Getting it wrong in the safe-looking direction is what hurts: a terminal failure marked retryable becomes a scheduler spinning on a request that can never succeed.

Fields§

§code: String

Stable machine-readable code.

§retryable: bool

Whether an identical retry could succeed later.

§message: String

Human-readable detail.

Implementations§

Source§

impl Failure

Source

pub fn terminal(code: &str, message: impl Into<String>) -> Self

A terminal failure: retrying the identical request cannot help.

Source

pub fn transient(code: &str, message: impl Into<String>) -> Self

A transient failure: the same request may succeed later.

Source

pub fn to_json(&self) -> Value

The wire form an adapter forwards to its orchestrator.

Trait Implementations§

Source§

impl Clone for Failure

Source§

fn clone(&self) -> Failure

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Failure

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for Failure

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Eq for Failure

Source§

impl StructuralPartialEq for Failure

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.