Crate common_procedure 

Common traits and structures for the procedure framework.

Re-exports

pub use crate::error::Error;

pub use crate::error::Result;

pub use crate::event::ProcedureEvent;

pub use crate::watcher::Watcher;

Modules

error

event

local

options

Common traits and structures for the procedure framework.

procedure 🔒

rwlock

store

test_util

watcher

Structs

Context

Procedure execution context.

EventContext

Framework-owned context supplied when a procedure builds a lifecycle event.

LockKey

Keys to identify required locks.

ParseIdError

PoisonKey

PoisonKeys

A collection of PoisonKeys.

ProcedureContext

Context attached to a procedure submission and inherited by its children.

ProcedureId

Unique id for Procedure.

ProcedureInfo

ProcedureWithId

A procedure with specific id.

Enums

ChildSubmissionOutcome

Outcome of submitting a child procedure.

EventTrigger

Lifecycle action that causes the framework to invoke Procedure::event.

ProcedureState

State of a submitted procedure.

RetryPhase

Phase of a procedure retry.

Status

Procedure execution status.

StringKey

Traits

ContextProvider

ContextProvider provides information about procedures in the ProcedureManager.

Procedure

A Procedure represents an operation or a set of operations to be performed step-by-step.

ProcedureManager

ProcedureManager executes Procedure submitted to it.

Type Aliases

BoxedProcedure

Boxed Procedure.

BoxedProcedureLoader

Loader to recover the Procedure instance from serialized data.

ContextProviderRef

Reference-counted pointer to ContextProvider.

Output

ProcedureManagerRef

Ref-counted pointer to the ProcedureManager.