Struct RuntimeBuilder 

pub struct RuntimeBuilder<S> { /* private fields */ }

Configures a Runtime.

Implementations

impl<S: EffectStore> RuntimeBuilder<S>

pub fn retention(self, policy: RetentionPolicy) -> Self

How long settled records are kept before Runtime::prune (and every round of Runtime::run_recovery) deletes them; see retention. Defaults to keeping them forever.

pub fn observer(self, observer: impl EffectObserver) -> Self

Tells observer about every effect recorded and every transition stored, for metrics; see observer. May be called more than once.

pub fn redactor(self, redactor: impl Redactor) -> Self

Rewrites every input, output, audit payload and error message before it is stored; see redaction.

pub fn risk_policy(self, policy: RiskPolicy) -> Self

Adds requirements by risk level and effect kind to every effect; see RiskPolicy. Requirements only accumulate on top of each effect’s own settings.

pub fn approval_provider(self, provider: impl ApprovalProvider) -> Self

Asks provider to decide on effects that require approval; see approval. Without one, such effects wait for an operator’s Runtime::approve or Runtime::deny.

pub fn register<H: EffectHandler>(self, handler: Handler<H>) -> Self

Registers a durable handler under its EffectHandler::NAME, so Runtime::submit can run it and Runtime::recover can finish its effects without a caller.

Panics

If a handler is already registered under the same name.

pub fn clock(self, clock: impl Clock) -> Self

The time source for leases and schedules. Defaults to the system clock. Tests with paused Tokio time want TokioClock.

pub fn worker_id(self, worker: WorkerId) -> Self

This runtime’s identity as a lease holder. Defaults to a random id. Must be unique among runtimes sharing a store.

pub fn lease_ttl(self, ttl: Duration) -> Self

How long a lease lasts without renewal. The runtime renews it every third of this while it works on an effect, including while it waits between retries. If a worker dies, others wait this long before treating its in-flight effect as unknown. Defaults to 30 seconds; values under 3 ms are raised to 3 ms.

pub fn retry_policy(self, policy: RetryPolicy) -> Self

The retry policy for effects that do not set their own. Defaults to RetryPolicy::default: 5 attempts, 1 s to 30 s exponential backoff with jitter.

pub fn fault_injector(self, injector: Arc<FaultInjector>) -> Self

Simulates crashes at the injector’s armed points. For tests; see fault.

pub fn build(self) -> Runtime<S>

Builds the runtime.