Struct GroupMutableMetadata 

pub struct GroupMutableMetadata {
    pub admin_list: Vec<String>,
    pub super_admin_list: Vec<String>,
    /* private fields */
}

Represents the mutable metadata for a group.

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

The _commit_log_signer attribute holds the group’s commit-log private key as hex. Debug redacts it and it is wiped on drop. The attribute map is private: read it with GroupMutableMetadata::attributes and change it with GroupMutableMetadata::insert_attribute and GroupMutableMetadata::remove_attribute, which wipe the value they replace or remove.

Fields

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>, ) -> GroupMutableMetadata

Creates a new GroupMutableMetadata instance.

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

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, ) -> GroupMutableMetadata

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.

The hex decodes straight into the zeroizing buffer that the Secret takes over. A 0x or 0X prefix is accepted, as hex::decode does.

pub fn attributes(&self) -> &HashMap<String, String>

The attributes, read-only. Change them with Self::insert_attribute and Self::remove_attribute.

pub fn take_attributes(&mut self) -> HashMap<String, String>

Move the attributes out, leaving the map empty. The caller owns the values, the commit-log signer included.

pub fn insert_attribute(&mut self, key: String, value: String)

Set an attribute, wiping the value it replaces.

pub fn remove_attribute(&mut self, key: &str)

Remove an attribute, wiping its value.

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<(), Error>

Formats the value using the given formatter.

impl Drop for GroupMutableMetadata

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

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<&Vec<u8>> for GroupMutableMetadata

fn try_from( value: &Vec<u8>, ) -> Result<GroupMutableMetadata, <GroupMutableMetadata as TryFrom<&Vec<u8>>>::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<Vec<u8>, <Vec<u8> as TryFrom<GroupMutableMetadata>>::Error>

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

The attributes move into the proto, whose signer value is wiped after encoding. The returned bytes are the extension handed to OpenMLS.

type Error = GroupMutableMetadataError

The type returned in the event of a conversion error.

impl TryFrom<GroupMutableMetadataV1> for GroupMutableMetadata

fn try_from( value: GroupMutableMetadataV1, ) -> Result<GroupMutableMetadata, <GroupMutableMetadata as TryFrom<GroupMutableMetadataV1>>::Error>

Converts a GroupMutableMetadataProto to GroupMutableMetadata.

type Error = GroupMutableMetadataError

The type returned in the event of a conversion error.

impl StructuralPartialEq for GroupMutableMetadata