Struct Circles 

pub struct Circles<'a> { /* private fields */ }

A borrowed namespace whose work remains owned by the open store. Making a circle and each change is its CovenWrite step in a write of its own, returning the operation’s id; a change returns None when the applied state already has what it asks for (§11.1). Lists read the committed state, as their subscriptions do.

Implementations

impl<'a> Circles<'a>

pub async fn reset(&self, circle: CircleId) -> Result<(), SyncError>

Reset this circle to a snapshot of this device’s state (§19.4).

pub async fn create( &self, name: &str, ) -> Result<(CircleId, OperationId), SyncError>

Make a circle (CovenWrite::create_circle).

pub async fn rename( &self, circle: CircleId, name: &str, ) -> Result<Option<OperationId>, SyncError>

Rename a circle (CovenWrite::rename_circle).

pub async fn delete( &self, circle: CircleId, ) -> Result<Option<OperationId>, SyncError>

Delete a circle (CovenWrite::delete_circle).

pub async fn add_member( &self, circle: CircleId, member: &MemberId, ) -> Result<Option<OperationId>, SyncError>

Add a store member to a circle (CovenWrite::add_circle_member).

pub async fn remove_member( &self, circle: CircleId, member: &MemberId, ) -> Result<Option<OperationId>, SyncError>

Remove a member from a circle (CovenWrite::remove_circle_member).

pub async fn list(&self) -> CovenResult<Vec<Circle>>

The circles this member is in.

pub fn subscribe_list(&self) -> LiveQuery<Vec<Circle>, CovenError>

The same circle-list query, live (E4).

pub async fn members( &self, circle: CircleId, ) -> CovenResult<Vec<CircleMemberInfo>>

A circle’s members who are still in the store.

pub fn subscribe_members( &self, circle: CircleId, ) -> LiveQuery<Vec<CircleMemberInfo>, CovenError>

The same query for this circle’s members, live (E4).