pub struct WorkflowRuntime<R, H> { /* private fields */ }Expand description
Durable runtime for workflow runs. Cheap to clone (internally Arc).
Implementations§
Source§impl<R: StepRunner, H: TerminalHook> WorkflowRuntime<R, H>
impl<R: StepRunner, H: TerminalHook> WorkflowRuntime<R, H>
Sourcepub fn builder(
queue: Arc<Queue>,
runner: R,
terminal_hook: H,
) -> WorkflowRuntimeBuilder<R, H>
pub fn builder( queue: Arc<Queue>, runner: R, terminal_hook: H, ) -> WorkflowRuntimeBuilder<R, H>
Start configuring a runtime. Takes the three required dependencies
(Taquba queue, StepRunner, TerminalHook); optional fields are
set via WorkflowRuntimeBuilder methods before build.
Use crate::NoopTerminalHook if you don’t need terminal callbacks.
Sourcepub async fn submit(&self, spec: RunSpec) -> Result<RunHandle>
pub async fn submit(&self, spec: RunSpec) -> Result<RunHandle>
Submit a new run. Enqueues step 0 with payload spec.input. Idempotent
against in-process duplicates: if a run with the same run_id is
already active in this runtime, returns Error::DuplicateRun.
Cross-process / cross-restart duplicate-prevention is enforced by
Taquba’s dedup key on the step job.
Sourcepub async fn status(&self, run_id: &str) -> Option<RunStatus>
pub async fn status(&self, run_id: &str) -> Option<RunStatus>
Look up the in-process status of a run. Returns None for unknown or
already-terminated runs (the registry only retains active runs).
Returns RunState::Cancelling for any run with a pending
cancellation request, regardless of its underlying step lifecycle
position; the cancellation overlay wins over Pending/Running
until the terminal hook fires.
Sourcepub async fn cancel(&self, run_id: &str) -> Result<bool>
pub async fn cancel(&self, run_id: &str) -> Result<bool>
Request cancellation of an active run.
Returns Ok(true) if a cancellation was initiated for run_id, or
Ok(false) if the run is not active in this runtime (already
terminal, never submitted here, or owned by a different runtime
instance).
The terminal hook fires once with TerminalStatus::Cancelled:
- Pending / scheduled step: the queued step job is cancelled in Taquba and the hook fires from this call before it returns.
- Running step: cancellation is delivered to the runner via
Step::cancel_token; runners that watch the token short-circuit immediately. Runners that ignore the token are allowed to run to completion (futures cannot be safely aborted mid-step). In both cases the runner’sStepOutcome/StepErroris discarded and the hook fires from the worker once the step returns, with any pending transient retry suppressed and the step acked rather than nacked.
Cancellation is best-effort: if the run is already terminal by the
time cancel is called (either because the runner returned a
terminating StepOutcome or a prior cancel already settled
it), cancel returns Ok(false), the run keeps whatever terminal
outcome it already delivered, and no additional hook fires.
Trait Implementations§
Auto Trait Implementations§
impl<R, H> Freeze for WorkflowRuntime<R, H>
impl<R, H> !RefUnwindSafe for WorkflowRuntime<R, H>
impl<R, H> Send for WorkflowRuntime<R, H>
impl<R, H> Sync for WorkflowRuntime<R, H>
impl<R, H> Unpin for WorkflowRuntime<R, H>
impl<R, H> UnsafeUnpin for WorkflowRuntime<R, H>
impl<R, H> !UnwindSafe for WorkflowRuntime<R, H>
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> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
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);