Struct StoreState 

pub struct StoreState {
    pub store: Option<StoreIdentity>,
    pub members: BTreeMap<MemberId, StoreMember>,
    pub bound_keys: BTreeSet<MemberPublicKeys>,
    pub devices: BTreeMap<DeviceId, StoreDevice>,
    pub circles: BTreeMap<CircleId, StoreCircle>,
    pub circle_deletions: BTreeMap<CircleId, Slot>,
    pub schema: BTreeMap<Audience, StoreVersion>,
    pub resets: BTreeMap<Audience, SnapshotId>,
}

Store state, including removed identities needed to check older writes (§10.4).

Schema versions belong to each audience: the store’s raise is under Audience::Store, and each circle has its own. A raise is absent until a kept raise selects it, as in §18.3; before one, the audience is at its base (StoreState::reached). These are independent of the local app migration version returned by crate::Database::schema_version.

Fields

store: Option<StoreIdentity>

Absent before the first entry creates the store.

members: BTreeMap<MemberId, StoreMember>

Every member added by a kept entry, including removed members.

bound_keys: BTreeSet<MemberPublicKeys>

Every public pair a kept creation, addition or member-key replacement bound, including pairs of removed members and pairs a later replacement retired. An addition of an id not active in its view, and every replacement, must share no key with these (§10).

devices: BTreeMap<DeviceId, StoreDevice>

Every device added by a kept entry, including removed devices.

circles: BTreeMap<CircleId, StoreCircle>

Every circle made by a kept entry, including deleted circles.

circle_deletions: BTreeMap<CircleId, Slot>

Deleted circles and their deciding slots; absence means no deletion.

schema: BTreeMap<Audience, StoreVersion>

The selected schema raise per audience; creation itself carries no raise. Self::reached gives an audience’s version, a circle’s base included.

resets: BTreeMap<Audience, SnapshotId>

The last kept reset of each audience (§19.4).

Implementations

impl StoreState

pub fn active_member(&self, id: &MemberId) -> Option<&StoreMember>

The member, unless a kept removal removed it.

pub fn device_acts_for(&self, device: &DeviceId, member: &MemberId) -> bool

Whether device is installed and active, and belongs to member.

pub fn active_admin(&self, id: &MemberId) -> bool

Whether id is a member who has not been removed and holds the admin role.

pub fn reads_circle(&self, circle: CircleId, member: &MemberId) -> bool

Whether member remains in the store and in circle, which exists and is not deleted (§15.5).

pub fn readable_circles(&self, member: &MemberId) -> BTreeSet<CircleId>

Every circle member reads under Self::reads_circle: the circles whose parts its devices open, snapshot and reload (§15.6, §16).

pub fn reached(&self, audience: &Audience) -> u32

The schema version audience has reached: the one its latest kept raise selected, or before any raise its base, zero for the store and for a circle the breaking version its creation recorded. A raise goes past the base, so this is the greater of the two (§16.3, §18.3).

pub fn awaits_raise(&self, audience: &Audience, version: u32) -> bool

Whether a part at version in audience waits for a raise: the audience is below that version and can still be raised. Nobody can raise a deleted circle, and its parts are taken out wherever they land (§15.9, §18.5).

pub fn gone_circle(&self, circle: &CircleId) -> bool

Whether circle is one this state doesn’t hold, or deleted: a change aimed at it meets a gone target (§10.4, §15.9).

pub fn deleted(&self, audience: &Audience) -> bool

Whether audience is a deleted circle (§15.9).

pub fn readable_audiences(&self, member: &MemberId) -> Vec<Audience>

Every audience member reads: the store’s, then each of Self::readable_circles in id order.

Trait Implementations

impl Clone for StoreState

fn clone(&self) -> StoreState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StoreState

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

Formats the value using the given formatter.

impl Default for StoreState

fn default() -> StoreState

Returns the “default value” for a type.

impl PartialEq for StoreState

fn eq(&self, other: &StoreState) -> 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 Eq for StoreState

impl StructuralPartialEq for StoreState