Struct GroupMutableMetadata 

pub struct GroupMutableMetadata {
    pub attributes: HashMap<String, String>,
    pub admin_list: Vec<String>,
    pub super_admin_list: Vec<String>,
}

Represents the mutable metadata for a group.

This struct is stored as an MLS Unknown Group Context Extension.

Fields

attributes: HashMap<String, String>

Map to store various metadata attributes (e.g., group name, description). Allows libxmtp to receive attributes from updated versions not yet captured in MetadataField.

admin_list: Vec<String>

List of admin inbox IDs for this group. See GroupMutablePermissions for more details on admin permissions.

super_admin_list: Vec<String>

List of super admin inbox IDs for this group. See GroupMutablePermissions for more details on super admin permissions.

Implementations

impl GroupMutableMetadata

pub fn new( attributes: HashMap<String, String>, admin_list: Vec<String>, super_admin_list: Vec<String>, ) -> Self

Creates a new GroupMutableMetadata instance.

pub fn new_default( creator_inbox_id: String, commit_log_signer: Option<Secret>, opts: GroupMetadataOptions, ) -> Self

Creates a new GroupMutableMetadata instance with default values. The creator is automatically added as a super admin. See GroupMutablePermissions for more details on super admin permissions.

pub fn new_dm_default( _creator_inbox_id: String, _dm_target_inbox_id: &str, commit_log_signer: Option<Secret>, opts: DMMetadataOptions, ) -> Self

pub fn supported_fields() -> Vec<MetadataField>

Returns a vector of supported metadata fields.

These fields will receive default permission policies for new groups.

pub fn is_admin(&self, inbox_id: &String) -> bool

Checks if the given inbox ID is an admin.

pub fn is_super_admin(&self, inbox_id: &String) -> bool

Checks if the given inbox ID is a super admin.

pub fn commit_log_signer(&self) -> Option<Secret>

Retrieves the commit log signer secret from the metadata attributes. Returns None if the field is not present or if hex decoding fails.

Trait Implementations

impl Clone for GroupMutableMetadata

fn clone(&self) -> GroupMutableMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GroupMutableMetadata

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

Formats the value using the given formatter.

impl PartialEq for GroupMutableMetadata

fn eq(&self, other: &GroupMutableMetadata) -> 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 TryFrom<&Extensions<GroupContext>> for GroupMutableMetadata

fn try_from(value: &Extensions<GroupContext>) -> Result<Self, Self::Error>

Attempts to extract GroupMutableMetadata from MLS Extensions.

type Error = GroupMutableMetadataError

The type returned in the event of a conversion error.

impl TryFrom<&MlsGroup> for GroupMutableMetadata

fn try_from(group: &OpenMlsGroup) -> Result<Self, Self::Error>

Attempts to extract GroupMutableMetadata from an OpenMlsGroup.

type Error = GroupMutableMetadataError

The type returned in the event of a conversion error.

impl TryFrom<&Vec<u8>> for GroupMutableMetadata

fn try_from(value: &Vec<u8>) -> Result<Self, Self::Error>

Converts a byte vector to GroupMutableMetadata.

type Error = GroupMutableMetadataError

The type returned in the event of a conversion error.

impl TryFrom<GroupMutableMetadata> for Vec<u8>

fn try_from(value: GroupMutableMetadata) -> Result<Self, Self::Error>

Converts GroupMutableMetadata to a byte vector for storage as an MLS Unknown Group Context Extension.

type Error = GroupMutableMetadataError

The type returned in the event of a conversion error.

impl TryFrom<GroupMutableMetadataV1> for GroupMutableMetadata

fn try_from(value: GroupMutableMetadataProto) -> Result<Self, Self::Error>

Converts a GroupMutableMetadataProto to GroupMutableMetadata.

type Error = GroupMutableMetadataError

The type returned in the event of a conversion error.

impl StructuralPartialEq for GroupMutableMetadata