Enum StoreChange 

pub enum StoreChange {
    CreateStore {
        store: StoreId,
        name: String,
        admin: MemberPublicKeys,
        access: MemberAccess,
        key: KeyId,
        key_hash: [u8; 32],
        device_name: String,
    },
    RenameStore {
        name: String,
    },
    AdmitMember {
        member: MemberId,
        keys: MemberPublicKeys,
        role: MemberRole,
        access: MemberAccess,
        device: DeviceId,
        device_name: String,
    },
    RecoverMember {
        member: MemberId,
        expected: MemberPublicKeys,
        keys: MemberPublicKeys,
        access: Option<MemberAccess>,
        device: DeviceId,
        device_name: String,
    },
    SetAccess {
        member: MemberId,
        access: MemberAccess,
    },
    RemoveMember {
        member: MemberId,
    },
    ChangeRole {
        member: MemberId,
        role: MemberRole,
    },
    AddDevice {
        name: String,
        replaces: Option<DeviceId>,
    },
    RemoveDevice {
        device: DeviceId,
    },
    CreateCircle {
        circle: CircleId,
        name: String,
        breaking_version: u32,
        key: KeyId,
        key_hash: [u8; 32],
    },
    RenameCircle {
        circle: CircleId,
        name: String,
    },
    DeleteCircle {
        circle: CircleId,
    },
    AddCircleMember {
        circle: CircleId,
        member: MemberId,
    },
    RemoveCircleMember {
        circle: CircleId,
        member: MemberId,
    },
    RotateKey {
        audience: Audience,
        key: KeyId,
        key_hash: [u8; 32],
    },
    RaiseSchema {
        version: u32,
        announcement: Slot,
    },
    Reset {
        announcement: Slot,
    },
    ReplaceMemberKeys {
        member: MemberId,
        expected: MemberPublicKeys,
        keys: MemberPublicKeys,
    },
    AddInviteShare {
        invite: InviteId,
        account: String,
    },
    EndInviteShare {
        invite: InviteId,
    },
}

Every admin operation listed in §10, including store creation.

Variants

CreateStore

Create a store, name its first admin and register the writing device. The entry’s author is the first admin’s stable id; admin supplies that member’s initial pair, which verifies this entry (D6).

Fields

store: StoreId

The store’s id.

name: String

The store’s name.

admin: MemberPublicKeys

The first admin’s initial public pair.

access: MemberAccess

The owner’s provider account or public S3 key id.

key: KeyId

The first store key, introduced by this entry.

key_hash: [u8; 32]

SHA-256 of the exact 32 store-key bytes.

device_name: String

The name of the device that wrote this entry, belonging to its author.

RenameStore

Set the store name, as an admin in the preceding state (§10).

Fields

name: String

The new name.

AdmitMember

Admit a joining person: add their stable id with both public keys, their initial role and access, and register the device their request names. Only an admission slot holds it, beside the member’s key copies (§13.2, D9).

Fields

member: MemberId

The added member’s stable id, fixed by the admin’s invite.

keys: MemberPublicKeys

The member’s initial public pair.

role: MemberRole

The initial role.

access: MemberAccess

Storage access granted by the inviting owner.

device: DeviceId

The joining installation, registered for the member. Never the writing device.

device_name: String

The joining installation’s name, from its request.

RecoverMember

Recover an active member on a new device: rebind their pair, as replace-member-keys does, set their access when the invite carried a new S3 key, and register the device their request names. Only an admission slot holds it (§13.2, D9).

Fields

member: MemberId

The recovered member.

expected: MemberPublicKeys

The binding which must still be current before this slot.

keys: MemberPublicKeys

The member’s new public pair.

access: Option<MemberAccess>

The member’s new storage access, as set-access records it: the S3 key the recovery invite carries. None keeps their access.

device: DeviceId

The new installation, registered for the member. Never the writing device.

device_name: String

The new installation’s name, from its request.

SetAccess

Record a member’s current storage access, used by a later removal (§10): the author’s own, or an admin’s replacement S3 key for another member.

Fields

member: MemberId

The member whose access this records.

access: MemberAccess

The provider account, or the S3 key id and its principal; no credentials.

RemoveMember

Remove a member and delete circles left empty (§14.1).

Fields

member: MemberId

The removed member.

ChangeRole

Set a member’s role.

Fields

member: MemberId

The affected member.

role: MemberRole

The target role.

AddDevice

Register the writing install for the entry’s author: an install registers only itself (§10.2).

Fields

name: String

The device’s name.

replaces: Option<DeviceId>

The older install of the same member being replaced, if any (§19.3). Must differ from the writing device.

RemoveDevice

Remove a device’s access.

Fields

device: DeviceId

The removed install.

CreateCircle

Make a circle with its creator as its first member.

Fields

circle: CircleId

The new circle’s id.

name: String

The circle’s name.

breaking_version: u32

The newest breaking migration its maker’s app had run, zero if none: the circle’s schema version until a raise of its own goes past it (§15.5, §16.3).

key: KeyId

The first circle key, introduced by this entry.

key_hash: [u8; 32]

SHA-256 of the exact 32 circle-key bytes.

RenameCircle

Rename a circle without changing its members, keys or rows.

Fields

circle: CircleId

The circle being renamed.

name: String

Its new name.

DeleteCircle

Delete a circle (§15.9).

Fields

circle: CircleId

The deleted circle.

AddCircleMember

Add a store member to a circle (§15.5).

Fields

circle: CircleId

The circle being joined.

member: MemberId

The added member.

RemoveCircleMember

Remove a circle member, deleting the circle if left empty (§15.8).

Fields

circle: CircleId

The circle being left.

member: MemberId

The removed member.

RotateKey

Introduce a key without changing audience membership (§12.1).

Fields

audience: Audience

The audience whose member authored the rotation.

key: KeyId

The introduced key’s random id.

key_hash: [u8; 32]

SHA-256 of the exact 32 key bytes.

RaiseSchema

Raise an audience’s app schema version with its replacement snapshot (§18.3).

Fields

version: u32

The new schema version.

announcement: Slot

The earlier announcement of the prepared snapshot.

Reset

Reset the store’s or a circle’s rows to a snapshot (§19.4).

Fields

announcement: Slot

The earlier announcement of the prepared reset snapshot.

ReplaceMemberKeys

Replace an active member’s public pair, keeping their id, role, access, circles and devices (§10). It carries no audience keys.

Fields

member: MemberId

The member whose keys change.

expected: MemberPublicKeys

The binding which must still be current before this slot.

keys: MemberPublicKeys

The member’s new public pair.

AddInviteShare

Record that the writing device’s invite shares the store with a provider account (§13.2, §14.2). Claimed before the grant, so the owner’s other devices know of the share and take it back once the invite ends or its device is gone for good.

Fields

invite: InviteId

The invite, fixed when it was made.

account: String

The provider account the invite shares the store with.

EndInviteShare

End the share the writing device recorded for its invite (§13.2).

Fields

invite: InviteId

The invite whose share ends.

Implementations

impl StoreChange

pub fn encode(&self) -> Result<Vec<u8>, Error>

Encode the one bounded kind-4 admin frame (D6).

pub fn decode(bytes: &[u8]) -> Result<Self, Error>

Decode exactly one admin frame. Slot-dependent authorization is separate.

Trait Implementations

impl Clone for StoreChange

fn clone(&self) -> StoreChange

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StoreChange

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

Formats the value using the given formatter.

impl PartialEq for StoreChange

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

impl StructuralPartialEq for StoreChange