Struct GroupJoinInfo 

pub struct GroupJoinInfo {
    pub channel_id: String,
    pub group_info: GroupInfo,
    pub encryption_key: [u8; 32],
    pub key_info: GroupKeyInfo,
    pub relay_endpoints: Vec<RelayEndpoint>,
    pub invitation_metadata: Vec<Metadata>,
}

Complete information needed for a participant to join an encrypted group

This structure contains everything a new participant needs to join and participate in an encrypted group, including the group metadata, encryption keys, channel information, and relay endpoints for communication.

Fields

channel_id: String

Hash ID of the initial CreateGroup message

This serves as the unique channel ID for the group and is derived from the Blake3 hash of the initial CreateGroup message.

group_info: GroupInfo

Group information from the CreateGroup event

Contains the group name, description, metadata, settings, and other information that was specified when the group was created.

encryption_key: [u8; 32]

Encryption key for the group

The shared AES key used to encrypt and decrypt group messages. This is the raw key bytes that participants need to encrypt/decrypt group communications.

key_info: GroupKeyInfo

Key derivation information

Contains metadata about how the encryption key was derived, including key ID and derivation parameters. This helps participants identify and manage the correct encryption keys.

relay_endpoints: Vec<RelayEndpoint>

List of relay endpoints (ordered by priority)

Contains the relay servers that participants can use to communicate within the group. The list is ordered by priority, with the first endpoint being the preferred relay. Participants should try relays in order until they find one that works.

invitation_metadata: Vec<Metadata>

Optional invitation metadata

Additional information about the invitation, such as who sent it, when it was created, expiration time, or invitation-specific settings.

Implementations

impl GroupJoinInfo

pub fn new( channel_id: String, group_info: GroupInfo, encryption_key: [u8; 32], key_info: GroupKeyInfo, relay_endpoints: Vec<RelayEndpoint>, ) -> Self

Create new group join information

pub fn with_invitation_metadata(self, metadata: Metadata) -> Self

Add metadata to the invitation

pub fn add_relay(self, endpoint: RelayEndpoint) -> Self

Add a relay endpoint to the list

pub fn primary_relay(&self) -> Option<&RelayEndpoint>

Get the primary (first priority) relay endpoint

pub fn relays_by_priority(&self) -> &[RelayEndpoint]

Get all relay endpoints ordered by priority

pub fn has_relays(&self) -> bool

Check if this invitation has any relay endpoints

Trait Implementations

impl Clone for GroupJoinInfo

fn clone(&self) -> GroupJoinInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GroupJoinInfo

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for GroupJoinInfo

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for GroupJoinInfo

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for GroupJoinInfo

impl StructuralPartialEq for GroupJoinInfo