Enum GroupBroadcast 

pub enum GroupBroadcast {
    Create {
        initial_invitees: Vec<u64>,
        options: MessageGroupOptions,
    },
    LeaveRoom {
        key: MessageGroupKey,
    },
    LeaveRoomResponse {
        key: MessageGroupKey,
        success: bool,
        message: String,
    },
    End {
        key: MessageGroupKey,
    },
    EndResponse {
        key: MessageGroupKey,
        success: bool,
    },
    Disconnected {
        key: MessageGroupKey,
    },
    Message {
        sender: u64,
        key: MessageGroupKey,
        message: SecBuffer,
    },
    MessageResponse {
        key: MessageGroupKey,
        success: bool,
    },
    KeyPackage {
        key: MessageGroupKey,
        joiner_cid: u64,
        payload: Vec<u8>,
    },
    Welcome {
        key: MessageGroupKey,
        joiner_cid: u64,
        payload: Vec<u8>,
    },
    Commit {
        key: MessageGroupKey,
        epoch: u64,
        payload: Vec<u8>,
    },
    HierarchyAssign {
        key: MessageGroupKey,
        target_cid: u64,
        payload: Vec<u8>,
    },
    Promote {
        key: MessageGroupKey,
        target_cid: u64,
        path: CommandPath,
    },
    Demote {
        key: MessageGroupKey,
        target_cid: u64,
    },
    Add {
        key: MessageGroupKey,
        invitees: Vec<u64>,
    },
    AddResponse {
        key: MessageGroupKey,
        failed_to_invite_list: Option<Vec<u64>>,
    },
    AcceptMembership {
        target: u64,
        key: MessageGroupKey,
    },
    DeclineMembership {
        target: u64,
        key: MessageGroupKey,
    },
    AcceptMembershipResponse {
        key: MessageGroupKey,
        success: bool,
    },
    DeclineMembershipResponse {
        key: MessageGroupKey,
        success: bool,
    },
    Kick {
        key: MessageGroupKey,
        kick_list: Vec<u64>,
    },
    KickResponse {
        key: MessageGroupKey,
        success: bool,
    },
    ListGroupsFor {
        cid: u64,
    },
    ListResponse {
        groups: Vec<MessageGroupKey>,
    },
    RequestJoin {
        sender: u64,
        key: MessageGroupKey,
    },
    Invitation {
        sender: u64,
        key: MessageGroupKey,
    },
    CreateResponse {
        key: Option<MessageGroupKey>,
    },
    MemberStateChanged {
        key: MessageGroupKey,
        state: MemberState,
    },
    GroupNonExists {
        key: MessageGroupKey,
    },
    RequestJoinPending {
        result: Result<(), String>,
        key: MessageGroupKey,
    },
    RestoreMembership {
        key: MessageGroupKey,
    },
    RestoreOwnership {
        key: MessageGroupKey,
    },
    MessageDropped {
        key: MessageGroupKey,
        sender: u64,
        reason: String,
    },
}

Enum representing different types of group broadcast messages

Variants

Create

Create a new group with initial invitees

Fields

initial_invitees: Vec<u64>

CIDs of initial members

options: MessageGroupOptions

Group configuration options

LeaveRoom

Leave a group

Fields

key: MessageGroupKey

Group key

LeaveRoomResponse

Response to leaving a group

Fields

key: MessageGroupKey

Group key

success: bool

Success status

message: String

Response message

End

End a group

Fields

key: MessageGroupKey

Group key

EndResponse

Response to ending a group

Fields

key: MessageGroupKey

Group key

success: bool

Success status

Disconnected

Disconnected from a group

Fields

key: MessageGroupKey

Group key

Message

Message broadcast to a group

Fields

sender: u64

Sender CID

key: MessageGroupKey

Group key

message: SecBuffer

Message payload

MessageResponse

Response to a message broadcast

Fields

key: MessageGroupKey

Group key

success: bool

Success status

KeyPackage

A joiner publishes its post-quantum TreeKEM KeyPackage to the group owner so the owner can Add it to the ratchet tree. payload is an opaque serialized citadel_treekem::KeyPackage — the relay forwards it verbatim and never inspects it (zero-trust).

Fields

key: MessageGroupKey

Group key

joiner_cid: u64

The joining member’s CID (so the owner knows where to route the Welcome)

payload: Vec<u8>

Opaque serialized citadel_treekem::KeyPackage

Welcome

The group owner delivers a TreeKEM Welcome to a single joiner (routed to joiner_cid). payload is an opaque serialized citadel_treekem::Welcome; the relay never inspects it.

Fields

key: MessageGroupKey

Group key

joiner_cid: u64

The joining member’s CID (the server routes this packet to this CID)

payload: Vec<u8>

Opaque serialized citadel_treekem::Welcome

Commit

The group owner broadcasts a TreeKEM Commit to the existing members (everyone but the joiner). payload is an opaque serialized citadel_treekem::Commit; the relay never inspects it.

Fields

key: MessageGroupKey

Group key

epoch: u64

The epoch this commit advances the group into (monotonic; used for ordering/gating)

payload: Vec<u8>

Opaque serialized citadel_treekem::Commit

HierarchyAssign

The group owner delivers a Decentralized-Hierarchy-Encryption node-secret assignment to one member (routed to target_cid). payload is the member’s command path + node secret, sealed to that member’s leaf KEM key — opaque to the relay, which sees neither the path nor the secret.

Fields

key: MessageGroupKey

Group key

target_cid: u64

The member receiving the assignment (the server routes this packet to this CID)

payload: Vec<u8>

Opaque KEM-sealed citadel_treekem::HierarchyMember

Promote

Owner-local request (from the group handle) to assign/raise target_cid to path. Handled entirely on the owner node — it never reaches the relay; the resulting Self::HierarchyAssign (carrying only the sealed node secret) is what goes on the wire, so path stays off it.

Fields

key: MessageGroupKey

Group key

target_cid: u64

The member being (re)assigned

path: CommandPath

The command path to assign (owner-local; never serialized to the relay)

Demote

Owner-local request (from the group handle) to revoke target_cid’s elevated rank. Handled on the owner node: it rotates the hierarchy, re-seals each member’s assignment, and epoch-bumps.

Fields

key: MessageGroupKey

Group key

target_cid: u64

The member being demoted

Add

Add members to a group

Fields

key: MessageGroupKey

Group key

invitees: Vec<u64>

CIDs of members to add

AddResponse

Response to adding members to a group

Fields

key: MessageGroupKey

Group key

failed_to_invite_list: Option<Vec<u64>>

List of failed invitations

AcceptMembership

Accept membership in a group

Fields

target: u64

Target CID

key: MessageGroupKey

Group key

DeclineMembership

Decline membership in a group

Fields

target: u64

Target CID

key: MessageGroupKey

Group key

AcceptMembershipResponse

Response to accepting membership in a group

Fields

key: MessageGroupKey

Group key

success: bool

Success status

DeclineMembershipResponse

Response to declining membership in a group

Fields

key: MessageGroupKey

Group key

success: bool

Success status

Kick

Kick members from a group

Fields

key: MessageGroupKey

Group key

kick_list: Vec<u64>

CIDs of members to kick

KickResponse

Response to kicking members from a group

Fields

key: MessageGroupKey

Group key

success: bool

Success status

ListGroupsFor

List groups for a user

Fields

cid: u64

User CID

ListResponse

Response to listing groups for a user

Fields

groups: Vec<MessageGroupKey>

List of group keys

RequestJoin

Request to join a group

Fields

sender: u64

Sender CID

key: MessageGroupKey

Group key

Invitation

Invitation to join a group

Fields

sender: u64

Sender CID

key: MessageGroupKey

Group key

CreateResponse

Response to creating a group

Fields

key: Option<MessageGroupKey>

Group key (optional)

MemberStateChanged

Member state changed

Fields

key: MessageGroupKey

Group key

state: MemberState

New member state

GroupNonExists

Group does not exist

Fields

key: MessageGroupKey

Group key

RequestJoinPending

Request to join a group is pending

Fields

result: Result<(), String>

Result of the request

key: MessageGroupKey

Group key

RestoreMembership

Server → member, when the member’s session is (re-)established while the server still lists it in key. A new session holds no TreeKEM state, so the member answers by publishing a fresh Self::KeyPackage; the owner re-adds it (replacing its stale leaf) and returns a Welcome. The relay handles only the same opaque KeyPackage/Welcome as an ordinary join.

Fields

key: MessageGroupKey

Group key

RestoreOwnership

Restoring a group whose owner’s session ended and was re-established within the grace period.

Server → owner, at the owner’s (re)connect: the group still exists here but the owner’s TreeKEM state died with its old session. The owner re-founds the tree (fresh leaf secret, epoch 0) and opens a group channel, then echoes this signal back.

Owner → server, once re-founded: the server sends Self::RestoreMembership to every member, who rejoin the new tree with fresh KeyPackages. Only the owner’s echo is acted on.

Fields

key: MessageGroupKey

Group key

MessageDropped

Local notice (never sent on the wire) that a group message addressed to this session was dropped because it could not be decrypted here, e.g. it arrived before this session’s Welcome. Delivered to the group channel if one is open, otherwise to the kernel as a GroupEvent.

Fields

key: MessageGroupKey

Group key

sender: u64

The sender of the dropped message

reason: String

Why it could not be delivered

Trait Implementations

impl Clone for GroupBroadcast

fn clone(&self) -> GroupBroadcast

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GroupBroadcast

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for GroupBroadcast

fn deserialize<__D>( __deserializer: __D, ) -> Result<GroupBroadcast, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<GroupBroadcast> for GroupBroadcastPayload

fn from(broadcast: GroupBroadcast) -> GroupBroadcastPayload

Convert GroupBroadcast to GroupBroadcastPayload

impl Serialize for GroupBroadcast

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.