Struct GroupControlMessage 

pub struct GroupControlMessage<ID, C> {
    pub group_id: ID,
    pub action: GroupAction<ID, C>,
}

Control messages which are processed in order to update group state.

There are two variants, one containing a group action and the ID of the group to which the action should be applied. The other is a special message which can be used to “undo” a message which has been previously applied to the group.

Fields

group_id: ID

action: GroupAction<ID, C>

Implementations

impl<ID, C> GroupControlMessage<ID, C>

where ID: Copy,

pub fn is_create(&self) -> bool

Return true if this is a create control message.

pub fn group_id(&self) -> ID

Return the ID of the group this message should be applied to.

Trait Implementations

impl<ID: Clone, C: Clone> Clone for GroupControlMessage<ID, C>

fn clone(&self) -> GroupControlMessage<ID, C>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<ID: Debug, C: Debug> Debug for GroupControlMessage<ID, C>

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

Formats the value using the given formatter.

impl Operation<char, u32, GroupControlMessage<char, ()>> for TestOperation

fn id(&self) -> u32

Id of this operation.

fn author(&self) -> char

ID of the author of this operation.

fn dependencies(&self) -> Vec<u32>

Other operation dependencies.

fn previous(&self) -> Vec<u32>

The last graph tips in the group this operation belongs to.

fn payload(&self) -> GroupControlMessage<char, ()>

Payload of this operation.

impl Orderer<char, u32, GroupControlMessage<char, ()>> for TestOrderer

fn next_message( y: Self::State, control_message: &GroupControlMessage<MemberId, Conditions>, ) -> Result<(Self::State, Self::Operation), Self::Error>

Construct the next operation which should include meta-data required for establishing order between different operations.

In this implementation causal order is established between operations using a graph structure. Every operation contains a pointer to both the previous operations in a single auth group graph, and also the tips of any sub-group graphs.

type State = TestOrdererState

type Error = OrdererError

type Operation = TestOperation

fn queue( y: Self::State, message: &Self::Operation, ) -> Result<Self::State, Self::Error>

Queue up a new local or remote message.

fn next_ready_message( y: Self::State, ) -> Result<(Self::State, Option<Self::Operation>), Self::Error>

Retrieve the next ready message.