Skip to main content

HaltOn

Enum HaltOn 

Source
#[non_exhaustive]
pub enum HaltOn { Never, Failure, }
Expand description

When a task’s own outcome ends the workflow — the outcome complement of Task::terminal.

Authored as a string on a task: "halt_on": "failure". Absent means Self::Never, so every workflow written before this existed is unchanged.

#[non_exhaustive]: further modes (a status range, say) would otherwise break every downstream match. Match with a _ arm.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

Never

Never halt on outcome. The default, and the behaviour of every task that does not mention halt_on.

§

Failure

Halt once this task has run and failed — a recorded status of 400 or above, which covers the validation built-in’s 400, any handler returning TaskOutcome::Status in that range, and a handler returning Err (recorded as 500).

TaskOutcome::Skip records nothing and never halts, and TaskOutcome::Halt carries HALT_STATUS_CODE (299), below the threshold — it halts on its own account, not through this flag.

There is no "always": Task::terminal already spells that.

Trait Implementations§

Source§

impl Clone for HaltOn

Source§

fn clone(&self) -> HaltOn

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 Copy for HaltOn

Source§

impl Debug for HaltOn

Source§

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

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

impl Default for HaltOn

Source§

fn default() -> HaltOn

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for HaltOn

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Eq for HaltOn

Source§

impl PartialEq for HaltOn

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for HaltOn

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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> 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 = !

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

fn try_from(value: U) -> Result<T, !>

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.