Struct GroupCrdtState 

pub struct GroupCrdtState<ID, OP, M, C>
where
    ID: IdentityHandle,
    OP: OperationId + Ord,
{
    pub inner: GroupCrdtInnerState<ID, OP, M, C>,
}

State object for GroupCrdt containing an orderer state and the inner state.

Fields

inner: GroupCrdtInnerState<ID, OP, M, C>

Inner groups state.

Implementations

impl<ID, OP, M, C> GroupCrdtState<ID, OP, M, C>

where ID: IdentityHandle, OP: OperationId + Ord, M: Operation<ID, OP, C>, C: Conditions,

pub fn new() -> Self

Instantiate a new state.

pub fn root_members(&self, group_id: ID) -> Vec<(GroupMember<ID>, Access<C>)>

Get all direct members of a group.

This method does not recurse into sub-groups, but rather returns only the direct group members and their access levels.

pub fn members(&self, group_id: ID) -> Vec<(ID, Access<C>)>

Get all individuals of a group.

This method recurses into all sub-groups and returns a resolved list of individual group members and their access levels.

pub fn groups(&self, group_id: ID) -> Vec<(ID, Access<C>)>

Get all transitive groups inside a group.

This method recurses into all sub-groups and returns a resolved list of nested group members and their access levels.

pub fn traverse_members( &self, group_id: ID, depth: u32, ) -> Vec<(GroupMember<ID>, Access<C>)>

Traverse membership graph with a specified max. depth and return all visited members (individuals and transitive groups) of a group.

Set depth to 0 to traverse the full graph.

pub fn has_group(&self, group_id: ID) -> bool

Returns true if the passed group exists in the current state.

pub fn heads(&self) -> Vec<OP>

Current tips for the groups operation graph.

pub fn heads_filtered(&self, groups: &[ID]) -> Vec<OP>

Get graph tips filtered to only those which included “create” operation for passed group ids in their causal history.

impl<ID, OP, M, C> GroupCrdtState<ID, OP, M, C>

where ID: IdentityHandle + Ord + Display, OP: OperationId + Ord + Display, M: Operation<ID, OP, C>, C: Conditions,

pub fn display(&self, group_id: ID) -> String

Available on crate features test_utils only.

Print an auth group graph in DOT format for visualizing the group operation DAG.

Trait Implementations

impl<ID, OP, M: Clone, C: Clone> Clone for GroupCrdtState<ID, OP, M, C>

where ID: IdentityHandle + Clone, OP: OperationId + Ord + Clone,

fn clone(&self) -> GroupCrdtState<ID, OP, M, C>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<ID, OP, M: Debug, C: Debug> Debug for GroupCrdtState<ID, OP, M, C>

where ID: IdentityHandle + Debug, OP: OperationId + Ord + Debug,

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

Formats the value using the given formatter.

impl<ID, OP, M, C> Default for GroupCrdtState<ID, OP, M, C>

where ID: IdentityHandle, OP: OperationId + Ord, M: Operation<ID, OP, C>, C: Conditions,

fn default() -> Self

Returns the “default value” for a type.

impl<'de, ID, OP, M, C> Deserialize<'de> for GroupCrdtState<ID, OP, M, C>

where ID: IdentityHandle + Deserialize<'de>, OP: OperationId + Ord + Deserialize<'de>, M: Deserialize<'de>, C: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<ID, OP, M, C> Serialize for GroupCrdtState<ID, OP, M, C>

where ID: IdentityHandle + Serialize, OP: OperationId + Ord + Serialize, M: Serialize, C: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.