pub struct Circles<'a> { /* private fields */ }Expand description
The coven.circles() namespace. Borrowed from a CovenHandle; holds no
state of its own.
Implementations§
Source§impl<'a> Circles<'a>
impl<'a> Circles<'a>
Sourcepub async fn create(&self, name: &str) -> Result<CircleId, CircleError>
pub async fn create(&self, name: &str) -> Result<CircleId, CircleError>
Create and activate a Circle whose founder is this Store identity. Returns only after the signed roster, metadata, access set, control, Store commit, activation head, and local materialization are durable.
Sourcepub async fn rename(
&self,
circle_id: CircleId,
name: &str,
) -> Result<(), CircleError>
pub async fn rename( &self, circle_id: CircleId, name: &str, ) -> Result<(), CircleError>
Rename a Circle without changing its epoch key, membership, rows, or package history.
Sourcepub async fn add_member(
&self,
circle_id: CircleId,
member_pubkey: &str,
) -> Result<(), CircleError>
pub async fn add_member( &self, circle_id: CircleId, member_pubkey: &str, ) -> Result<(), CircleError>
Add (or re-add) a Store identity to the Circle’s roster, sealing it a fresh active access leaf and current bootstrap.
Sourcepub async fn remove_member(
&self,
circle_id: CircleId,
member_pubkey: &str,
) -> Result<CircleOperationId, CircleError>
pub async fn remove_member( &self, circle_id: CircleId, member_pubkey: &str, ) -> Result<CircleOperationId, CircleError>
Remove a Store identity from the Circle, closing the old epoch. Returns the durable operation id tracking the close.
Sourcepub async fn resolve(
&self,
circle_id: CircleId,
chosen: CircleControlCoord,
) -> Result<(), CircleError>
pub async fn resolve( &self, circle_id: CircleId, chosen: CircleControlCoord, ) -> Result<(), CircleError>
Resolve a forked Circle control by authoring a successor of the chosen branch. Callable regardless of rotation state — it is the exit path out of the conflict.
Sourcepub async fn cancel_close(
&self,
circle_id: CircleId,
) -> Result<CircleOperationId, CircleError>
pub async fn cancel_close( &self, circle_id: CircleId, ) -> Result<CircleOperationId, CircleError>
Cancel an in-flight epoch close, restoring the frozen epoch. Returns the durable operation id the cancellation settles.
Sourcepub async fn exclude_close_device(
&self,
circle_id: CircleId,
device_id: StoreDeviceId,
) -> Result<(), CircleError>
pub async fn exclude_close_device( &self, circle_id: CircleId, device_id: StoreDeviceId, ) -> Result<(), CircleError>
Exclude an unavailable participant device from the Circle’s in-flight epoch close. The excluded device must reset from the successor bootstrap before it can write or acknowledge again.
Sourcepub async fn delete(&self, circle_id: CircleId) -> Result<(), CircleError>
pub async fn delete(&self, circle_id: CircleId) -> Result<(), CircleError>
Delete a Circle with an Owner-signed terminal control transition.
Sourcepub async fn retry_operation(
&self,
operation_id: CircleOperationId,
) -> Result<(), CircleError>
pub async fn retry_operation( &self, operation_id: CircleOperationId, ) -> Result<(), CircleError>
Retry a blocked durable operation from its captured phase, idempotently.
Sourcepub async fn discard_operation(
&self,
operation_id: CircleOperationId,
) -> Result<(), CircleError>
pub async fn discard_operation( &self, operation_id: CircleOperationId, ) -> Result<(), CircleError>
Discard a durable operation that can provably never activate, deleting its candidate-exclusive objects and clearing its journal row. Refused typed without a verified permanent-nonactivation proof.
Sourcepub async fn list(&self) -> Result<Vec<Circle>, CircleError>
pub async fn list(&self) -> Result<Vec<Circle>, CircleError>
Every Circle the local identity can see, with its derived
CircleState.
Sourcepub async fn members(
&self,
circle_id: CircleId,
) -> Result<Vec<CircleMemberInfo>, CircleError>
pub async fn members( &self, circle_id: CircleId, ) -> Result<Vec<CircleMemberInfo>, CircleError>
The Circle’s current members who remain current Store members, with roles.
Sourcepub async fn operations(&self) -> Result<Vec<CircleOperationInfo>, CircleError>
pub async fn operations(&self) -> Result<Vec<CircleOperationInfo>, CircleError>
Every durable Circle operation that has not activated, with its typed progress and block reason.
Sourcepub async fn close_status(
&self,
circle_id: CircleId,
) -> Result<CircleCloseStatus, CircleError>
pub async fn close_status( &self, circle_id: CircleId, ) -> Result<CircleCloseStatus, CircleError>
The read-only settlement status of a Circle’s in-flight epoch close.
Auto Trait Implementations§
impl<'a> Freeze for Circles<'a>
impl<'a> !RefUnwindSafe for Circles<'a>
impl<'a> Send for Circles<'a>
impl<'a> Sync for Circles<'a>
impl<'a> Unpin for Circles<'a>
impl<'a> UnsafeUnpin for Circles<'a>
impl<'a> !UnwindSafe for Circles<'a>
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more