Enum RingMembersState

pub enum RingMembersState {
    AppendOnly,
    Mutating(u8),
    KeyMigration,
}

The overarching state of all people rings regarding the actions that are currently allowed to be performed on them.

Variants

AppendOnly

The rings can accept new people sequentially if the maximum capacity has not been reached yet. Ring building is permitted in this state by building the ring roots on top of previously computed roots. In case a ring suffered mutations that invalidated a previous ring root through the removal of an included member, the existing ring root will be removed and ring building will start from scratch.

Mutating(u8)

A semaphore counting the number of entities making changes to the ring members list which require the entire ring to be rebuilt. Whenever a DIM would want to suspend people, it would first need to increment this counter and then start submitting the suspended indices. After all indices are registered, the counter is decremented. Ring merges are allowed only when no entity is allowed to suspend keys and the counter is 0.

KeyMigration

After mutations to the member set, any pending key migrations are enacted before the new ring roots will be built in order to reflect the latest changes in state.

Implementations

impl RingMembersState

pub fn append_only(&self) -> bool

Returns whether the state allows only incremental additions to rings and their roots.

pub fn mutating(&self) -> bool

Returns whether the state allows mutating the member set of rings.

pub fn key_migration(&self) -> bool

Returns whether the state allows the pending key migrations to be enacted.

pub fn start_mutation_session(self) -> Result<Self, ()>

Move to a mutation state.

pub fn end_mutation_session(self) -> Result<Self, ()>

Move out of a mutation state.

pub fn end_key_migration(self) -> Result<Self, ()>

Move out of a key migration state.

Trait Implementations

impl Clone for RingMembersState

fn clone(&self) -> RingMembersState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RingMembersState

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

Formats the value using the given formatter.

impl Decode for RingMembersState

fn decode<__CodecInputEdqy: Input>( __codec_input_edqy: &mut __CodecInputEdqy, ) -> Result<Self, Error>

Attempt to deserialise the value from input.

fn decode_into<I>( input: &mut I, dst: &mut MaybeUninit<Self>, ) -> Result<DecodeFinished, Error>

where I: Input,

Attempt to deserialize the value from input into a pre-allocated piece of memory.

fn skip<I>(input: &mut I) -> Result<(), Error>

where I: Input,

Attempt to skip the encoded value from input.

fn encoded_fixed_size() -> Option<usize>

Returns the fixed encoded size of the type.

impl Default for RingMembersState

fn default() -> Self

Returns the “default value” for a type.

impl Encode for RingMembersState

fn size_hint(&self) -> usize

If possible give a hint of expected size of the encoding.

fn encode_to<__CodecOutputEdqy: Output + ?Sized>( &self, __codec_dest_edqy: &mut __CodecOutputEdqy, )

Convert self to a slice and append it to the destination.

fn encode(&self) -> Vec<u8>

Convert self to an owned vector.

fn using_encoded<R, F>(&self, f: F) -> R

where F: FnOnce(&[u8]) -> R,

Convert self to a slice and then invoke the given closure with it.

fn encoded_size(&self) -> usize

Calculates the encoded size.

impl MaxEncodedLen for RingMembersState

fn max_encoded_len() -> usize

Upper bound, in bytes, of the maximum encoded size of this item.

impl PartialEq for RingMembersState

fn eq(&self, other: &RingMembersState) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TypeInfo for RingMembersState

type Identity = RingMembersState

The type identifying for which type info is provided.

fn type_info() -> Type

Returns the static type identifier for Self.

impl DecodeWithMemTracking for RingMembersState

impl EncodeLike for RingMembersState

impl Eq for RingMembersState

impl StructuralPartialEq for RingMembersState