Struct Op 

pub struct Op<O, M: Make<O>> { /* private fields */ }

An operation with options O, set by its builder methods, that runs when awaited: ctx.step("charge", f).retry(policy).await.

Implementations

impl<M: Make<StepOptions>> Op<StepOptions, M>

pub fn own_value(self) -> Self

See StepOptions::own_value.

pub fn retry(self, retry: RetryPolicy) -> Self

How failures are retried (default: RetryPolicy::default).

pub fn timeout(self, timeout: Duration) -> Self

Each attempt fails (and may be retried) if it runs longer than this.

pub fn heartbeat_timeout(self, timeout: Duration) -> Self

An attempt fails if this long passes without a ctx.heartbeat.

pub fn read_only(self) -> Self

The step only reads: it may run before the records ahead of it are durable (see StepOptions::read_only).

pub fn limit(self, name: &str) -> Self

Takes a permit of this limit before each attempt.

pub fn limit_by(self, name: &str, key: &str) -> Self

Takes a permit of name for this key only: each key (a tenant, an account) has its own permits, of the size engine.limit(name, …) gives, made on first use.

ctx.step("sync", || api.sync(&tenant)).limit_by("tenant", &tenant).await?;

pub fn priority(self, level: i32) -> Self

Waits for the limit’s permit ahead of steps with a lower level.

pub fn fairness(self, key: &str) -> Self

Steps waiting at one level take turns by this key.

pub fn fairness_weight(self, weight: u32) -> Self

Permits the fairness key takes per turn (default 1).

impl<M: Make<WaitOptions>> Op<WaitOptions, M>

pub fn timeout(self, timeout: Duration) -> Self

impl<M: Make<ChildOptions>> Op<ChildOptions, M>

pub fn parent_close(self, close: ParentClose) -> Self

What happens to the child when this workflow closes.

pub fn timeout(self, timeout: Duration) -> Self

The child’s own deadline.

impl<O, M: Make<O>> Op<O, M>

pub fn options(self, options: O) -> Self

Replaces every option at once.

impl<M: Make<StartOptions>> Op<StartOptions, M>

Options of a start (see Engine::start).

pub fn id_policy(self, policy: IdPolicy) -> Self

What happens when the workflow ID is taken.

pub fn use_existing(self) -> Self

Attaches to a run of this ID that is still going (a client that retries a start should).

pub fn timeout(self, timeout: Duration) -> Self

The run’s deadline from now.

pub fn version(self, version: u32) -> Self

The version to run (default: the newest registered).

pub fn delay(self, delay: Duration) -> Self

Starts the run after delay instead of now: a durable timer, then the start (crate::delay). result() waits through the delay.

pub fn at(self, at: SystemTime) -> Self

Starts the run at at instead of now (delay).

pub fn trace(self, traceparent: impl Into<String>) -> Self

The W3C traceparent the run joins (StartOptions::trace).

pub fn concurrency_key(self, key: impl Into<String>) -> Self

The key a limit on runs at once counts by (StartOptions::concurrency_key).

impl<M: Make<EventOptions>> Op<EventOptions, M>

pub fn event_id(self, id: &str) -> Self

impl<M: Make<UpdateOptions>> Op<UpdateOptions, M>

pub fn id(self, id: &str) -> Self

pub fn start_options(self, start: StartOptions) -> Self

For update-with-start: the start’s options.

impl<M: Make<CallOptions>> Op<CallOptions, M>

pub fn id(self, id: &str) -> Self

Trait Implementations

impl<O, M: Make<O>> Future for Op<O, M>

type Output = <M as Make<O>>::Output

The type of value produced on completion.

fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<M::Output>

Attempts to resolve the future to a final value, registering the current task for wakeup if the value is not yet available.