Struct RunGroup 

pub struct RunGroup { /* private fields */ }

A group of runs of one runtime, identified by a group id. Obtained from WorkflowRuntime::group or WorkflowRuntime::new_group; cheap to clone.

The group’s members are identified by key. A member’s run id is derived from the group id and its key, so the same input submitted to two groups runs twice, and a second submit of the group runs again every member that did not succeed. The group’s membership is a durable manifest, so results, status, cancel and forget answer after a restart and from any runtime over the same queue.

Implementations

impl RunGroup

pub fn id(&self) -> &RunId

The group id.

pub async fn submit( &self, members: Vec<GroupMember>, options: &RunOptions, ) -> Result<()>

Submit members as the group’s members. The first submission writes the group’s manifest; a later one with a different member set is rejected with Error::GroupMismatch, and one with the same set submits every member whose last recorded termination is not a success, so a group is re-submitted after a crash or to run its failed members again. Two members with one key are rejected with Error::DuplicateMemberKey. options applies to every member. A submission that fails returns after the members submitted so far.

pub async fn resume(&self, options: &RunOptions) -> Result<()>

Submit the members of the group’s manifest whose last recorded termination is not a success: a member still active continues, and the rest run. Returns Error::GroupNotFound for a group never submitted. options applies as in submit.

pub async fn results( &self, ) -> Result<impl Stream<Item = Result<MemberResult>> + use<>>

The members’ results as each one terminates, in completion order; a member already terminated is yielded at once. Returns Error::GroupNotFound for a group never submitted.

pub async fn status(&self) -> Result<GroupStatus>

The group’s durable state. Returns Error::GroupNotFound for a group never submitted.

pub async fn cancel(&self) -> Result<usize>

Request cancellation of every active member, as WorkflowRuntime::cancel does for one run. Returns the number of members whose request was recorded.

pub async fn forget(&self) -> Result<()>

Remove the group’s state: its manifest, member records and the memo entries, run result records and terminal records of its members. A later submit under the same id starts from nothing.

Trait Implementations

impl Clone for RunGroup

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.