Struct Child 

pub struct Child<P: Protocol> { /* private fields */ }

A protocol owned by another, with the inbox its indications are collected into.

Implementations

impl<P: Protocol> Child<P>

pub fn new(proto: P) -> Self

pub fn replace(&mut self, proto: P)

Replace the protocol, keeping the inbox’s allocation.

For a child that is rebuilt while running — the leader-driven consensus replaces its epoch consensus on every epoch change.

pub fn reclaim(&mut self, inbox: Vec<P::Ind>)

Put the inbox back after the indications run returned have been handled.

impl<P> Child<P>

where P: Protocol<Meta = Infallible, Entry = Infallible>,

pub fn run<M, I, Me, En>( &mut self, cx: &mut Cx<'_, M, I, P::Note, Me, En>, wrap: impl Fn(P::Msg) -> M, f: impl FnOnce(&mut P, &mut ProtoCx<'_, P>), ) -> Vec<P::Ind>

Run f against the child, forwarding what it sends as wrap(msg) and returning what it indicated for the parent to handle. Hand the returned inbox to Child::reclaim once done.

The child is handed no store — see Cx::with_child_consuming. A child that keeps something durably is run with Child::run_durable instead.

impl<P> Child<P>

where P: Protocol<Entry = Infallible>,

pub fn run_durable<M, I, Me, En>( &mut self, cx: &mut Cx<'_, M, I, P::Note, Me, En>, wrap: impl Fn(P::Msg) -> M, slot: Slot<Me, P::Meta>, f: impl FnOnce(&mut P, &mut ProtoCx<'_, P>), ) -> Vec<P::Ind>

Child::run, for a child that keeps durable metadata in slot of the parent’s record.

See Cx::with_durable_child_consuming for why the write is one and not two.

impl<P: Protocol> Child<P>

pub fn run_keyed<M, I, Me, En, K>( &mut self, cx: &mut Cx<'_, M, I, P::Note, Me, En>, wrap: impl Fn(P::Msg) -> M, slot: KeyedSlot<Me, P::Meta, K>, key: K, f: impl FnOnce(&mut P, &mut ProtoCx<'_, P>), ) -> Vec<P::Ind>

where P: Protocol<Entry = Infallible>,

Child::run_durable, for one member of a family of durable children.

See Cx::with_keyed_durable_child_consuming.

pub fn run_appending<M, I, Me, En>( &mut self, cx: &mut Cx<'_, M, I, P::Note, Me, En>, wrap: impl Fn(P::Msg) -> M, slot: Slot<Me, P::Meta>, entries: SeqSlot<En, P::Entry>, f: impl FnOnce(&mut P, &mut ProtoCx<'_, P>), ) -> Vec<P::Ind>

Child::run_durable, for a child that keeps metadata and appends.

See Cx::with_durable_child: the child’s entries go into the parent’s one sequence, so the order between a parent’s entry and its child’s is real rather than invented at recovery.

Trait Implementations

impl<P: Protocol + Debug> Debug for Child<P>

Shows the protocol. The inbox is empty between events, and its element type need not be Debug for the parent to be.

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<P: Protocol> Deref for Child<P>

type Target = P

The resulting type after dereferencing.

fn deref(&self) -> &P

Dereferences the value.

impl<P: Protocol> DerefMut for Child<P>

fn deref_mut(&mut self) -> &mut P

Mutably dereferences the value.