Skip to main content

TaskOutcome

Enum TaskOutcome 

Source
pub enum TaskOutcome {
    Success,
    Status(u16),
    Skip,
    Halt,
}
Expand description

Outcome of a single task execution.

Returned by AsyncFunctionHandler::execute and by the engine’s internal sync-builtin dispatch path. The workflow executor uses the variant to decide whether to continue, skip the audit trail, or halt the workflow.

HTTP-like status semantics (preserved from v3 and earlier):

  • status 200 — normal completion
  • status 400..500 — logged as a warning, workflow continues
  • status 500.. — recorded; fails the workflow unless the task or workflow has continue_on_error = true

Variants§

§

Success

Normal completion. Audit trail records status 200 and the workflow continues with the next task.

§

Status(u16)

Completion with an explicit HTTP-like status code. Audit trail records the supplied status. Codes in the 400..500 range log a warning; codes >= 500 fail the workflow unless continue_on_error is set.

§

Skip

Skip recording an audit trail entry for this task; continue with the next task. Used by filter gates that intentionally no-op when their condition does not match.

§

Halt

Record the audit trail (status HALT_STATUS_CODE) and stop further tasks in the current workflow. Subsequent workflows registered on the same engine still process this message normally.

Implementations§

Source§

impl TaskOutcome

Source

pub fn audit_status(self) -> Option<u16>

HTTP-like status code that will be stamped on the audit trail entry for this outcome. Skip returns None since no audit entry is recorded in that case.

Source

pub fn halts_workflow(self) -> bool

Whether the workflow executor should halt further tasks in this workflow after observing this outcome.

Trait Implementations§

Source§

impl Clone for TaskOutcome

Source§

fn clone(&self) -> TaskOutcome

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 TaskOutcome

Source§

impl Debug for TaskOutcome

Source§

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

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

impl Default for TaskOutcome

Source§

fn default() -> TaskOutcome

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

impl Eq for TaskOutcome

Source§

impl PartialEq for TaskOutcome

Source§

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

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> 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.