pub struct WorkflowEngine { /* private fields */ }Implementations§
Source§impl WorkflowEngine
impl WorkflowEngine
pub fn new(runner_url: &str, max_history: usize) -> Self
Sourcepub fn register(&self, def: WorkflowDef)
pub fn register(&self, def: WorkflowDef)
Register a workflow definition.
Sourcepub fn start(&self, name: &str, input: Value) -> Result<String, String>
pub fn start(&self, name: &str, input: Value) -> Result<String, String>
Start a new workflow instance. Returns the instance ID.
Sourcepub fn advance(&self, workflow_id: &str) -> Result<WorkflowStatus, String>
pub fn advance(&self, workflow_id: &str) -> Result<WorkflowStatus, String>
Execute the next step of a workflow by calling the TS runner.
The TS runner returns an action object describing what happened:
{ "action": "step_complete", "step_name": "...", "output": ... }{ "action": "sleep", "duration": "24h" }{ "action": "wait_event", "event": "user_confirmed" }{ "action": "complete", "output": ... }{ "action": "fail", "error": "...", "step_name": "..." }
Sourcepub fn advance_with_response(
&self,
workflow_id: &str,
response: Value,
) -> Result<WorkflowStatus, String>
pub fn advance_with_response( &self, workflow_id: &str, response: Value, ) -> Result<WorkflowStatus, String>
Advance a workflow with a pre-provided response (for testing without a running TS runner).
Sourcepub fn send_event(
&self,
workflow_id: &str,
event: &str,
data: Value,
) -> Result<(), String>
pub fn send_event( &self, workflow_id: &str, event: &str, data: Value, ) -> Result<(), String>
Send an event to a waiting workflow.
Sourcepub fn get(&self, workflow_id: &str) -> Option<WorkflowInstance>
pub fn get(&self, workflow_id: &str) -> Option<WorkflowInstance>
Get a workflow instance by ID.
Sourcepub fn list(&self, status: Option<&WorkflowStatus>) -> Vec<WorkflowInstance>
pub fn list(&self, status: Option<&WorkflowStatus>) -> Vec<WorkflowInstance>
List all workflow instances with optional status filter.
Sourcepub fn definitions(&self) -> Vec<WorkflowDef>
pub fn definitions(&self) -> Vec<WorkflowDef>
List registered workflow definitions.
Sourcepub fn wake_sleeping(&self) -> Vec<String>
pub fn wake_sleeping(&self) -> Vec<String>
Wake sleeping workflows whose timer has expired. Returns the IDs of workflows that were woken.
Sourcepub fn restore_from(&self, store: &WorkflowStore) -> usize
pub fn restore_from(&self, store: &WorkflowStore) -> usize
Restore active and sleeping workflows from a persistent store.
Loads all non-terminal workflows and inserts them into the in-memory instance map. Returns the number of workflows restored.
Call this once at startup, before the engine begins processing.
Trait Implementations§
Source§impl WorkflowOps for WorkflowEngine
impl WorkflowOps for WorkflowEngine
fn definitions(&self) -> Value
fn start(&self, name: &str, input: Value) -> Result<String, String>
fn list(&self, status_filter: Option<&str>) -> Value
fn get(&self, id: &str) -> Option<Value>
fn advance(&self, id: &str) -> Result<String, String>
fn send_event(&self, id: &str, event: &str, data: Value) -> Result<(), String>
fn cancel(&self, id: &str) -> Result<(), String>
Auto Trait Implementations§
impl !Freeze for WorkflowEngine
impl RefUnwindSafe for WorkflowEngine
impl Send for WorkflowEngine
impl Sync for WorkflowEngine
impl Unpin for WorkflowEngine
impl UnsafeUnpin for WorkflowEngine
impl UnwindSafe for WorkflowEngine
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);