Skip to main content

Task

Struct Task 

Source
#[non_exhaustive]
pub struct Task { pub id: String, pub name: String, pub description: Option<String>, pub condition: Value, pub function: FunctionConfig, pub continue_on_error: bool, pub terminal: bool, pub halt_on: HaltOn, /* private fields */ }
Expand description

A single processing unit within a workflow (also known as an Action in rules-engine terminology).

Tasks execute functions with optional conditions and error handling. They are processed sequentially within a workflow, allowing later tasks to depend on results from earlier ones.

§Example JSON Definition

{
    "id": "validate_user",
    "name": "Validate User Data",
    "description": "Ensures user data meets requirements",
    "condition": {">=": [{"var": "data.order.total"}, 1000]},
    "function": {
        "name": "validation",
        "input": { "rules": [...] }
    },
    "continue_on_error": false,
    "terminal": false,
    "halt_on": "failure"
}

A single unit of work inside a workflow.

#[non_exhaustive]: construct through Task::action and assign the public fields you need, or parse a workflow from JSON. Field reads and writes are unaffected, and .. patterns keep working.

The attribute exists because three of this struct’s fields — id_arc, compiled_condition, group_starts — are engine internals documented as not part of the stable API, yet struct-literal construction forced every caller to name them. Field additions had already broken those callers twice (3.3.0, 3.6.0); this is the change that stops it.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§id: String

Unique identifier for the task within the workflow.

§name: String

Human-readable name for the task.

§description: Option<String>

Optional description explaining what the task does.

§condition: Value

JSONLogic condition that determines if the task should execute. Conditions can access any context field (data, metadata, temp_data). Defaults to true (always execute).

§function: FunctionConfig

The function configuration specifying what operation to perform. Can be a built-in function (map, validation) or a custom function.

§continue_on_error: bool

Whether to continue workflow execution if this task fails. When true, errors are recorded but don’t stop the workflow. Defaults to false.

“Fails” means a 5xx outcome or a returned Err — not every unsuccessful task. A 4xx is logged as a warning and the workflow carries on regardless of this flag, so continue_on_error: false after a validation task does not stop the tasks that follow it: a failing rule returns 400. To gate on an outcome, use Task::halt_on; to reject the whole message, return an Err from a handler.

§terminal: bool

Whether running this task ends the workflow. Defaults to false.

terminal is a statement about position — “nothing after this runs” — not about outcome:

  • a false condition means the task never ran, so nothing halts;
  • TaskOutcome::Skip does not halt, for the same reason;
  • a task that failed under continue_on_error: true still halts, and its error is still recorded on message.errors().

Halting stops this workflow only; later workflows registered on the same engine still process the message. Inside a workflow carrying a LoopConfig it breaks the whole loop, not one sweep — the same scope as TaskOutcome::Halt.

The audit-trail entry keeps the task’s own status (200, 404, …) rather than HALT_STATUS_CODE: the task did its job, and a map that wrote a 404 response body should not report “a filter halted here”.

For the outcome axis — “halt only if this task failed” — see Task::halt_on.

§halt_on: HaltOn

Halt the workflow based on this task’s outcome. Defaults to HaltOn::Never.

The complement of Task::terminal: terminal is about position and halts whatever happened, halt_on is about what happened and halts only then. The two combine as terminal || (halt_on matched)terminal is strictly stronger, so setting both is redundant rather than contradictory.

This is what lets an assertion reject. A validation task returns 400 when a rule fails, which is not covered by continue_on_error, so without halt_on the tasks after it still run:

{ "id": "check_state", "halt_on": "failure",
  "function": { "name": "validation", "input": { "rules": [ … ] } } }

Failure means a recorded status of 400 or above — the same threshold the executor already splits on to warn (4xx) and to record TASK_STATUS_ERROR (5xx) — or a handler returning Err, recorded as 500. It is deliberately not “the task appended to message.errors()”: a handler may call TaskContext::add_error and still return Success, and that does not halt.

The task …terminal: truehalt_on: "failure"
never ran (its condition, or its group’s, was false)nono
returned TaskOutcome::Skipnono
returned Success, or a 2xx–3xx statushaltsno
returned TaskOutcome::Halthalts alreadyhalts already
returned a 4xx statushaltshalts
returned 5xx, continue_on_error: truehaltshalts
returned 5xx, continue_on_error: falseerror propagateserror propagates
handler returned Err, continue_on_error: truehaltshalts
handler returned Err, continue_on_error: falseerror propagateserror propagates
called add_error but returned Successhaltsno

The two “error propagates” rows are not an omission: the executor returns Err before either flag is consulted, which abandons the rest of this workflow — everything halting would have done — and additionally reaches the caller. They differ in exactly one shape: a workflow carrying a loop whose own continue_on_error is true, where the error advances to the next sweep while a halt would break the loop. Set continue_on_error: false on the workflow if the loop must stop.

Everything terminal documents about scope applies unchanged: halting stops this workflow only, later workflows still process the message, it breaks a whole loop rather than one sweep, and the audit entry keeps the task’s own status — 400, not HALT_STATUS_CODE. Halting is therefore not a security control: to stop a message outright return an Err, or gate the following workflow on EngineBuilder::with_error_context_path.

Implementations§

Source§

impl Task

Source

pub fn action(id: &str, name: &str, function: FunctionConfig) -> Self

Create a task (action) with default settings.

This is a convenience constructor for the IFTTT-style rules engine pattern, creating an action that always executes (condition defaults to true).

§Arguments
  • id - Unique identifier for the action
  • name - Human-readable name
  • function - The function configuration to execute

Trait Implementations§

Source§

impl Clone for Task

Source§

fn clone(&self) -> Task

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 Task

Source§

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

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

impl<'de> Deserialize<'de> for Task

Source§

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

Deserialize this value from the given Serde deserializer. Read more

Auto Trait Implementations§

§

impl !RefUnwindSafe for Task

§

impl !UnwindSafe for Task

§

impl Freeze for Task

§

impl Send for Task

§

impl Sync for Task

§

impl Unpin for Task

§

impl UnsafeUnpin for Task

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.