Struct mls_rs::MlsMessage

pub struct MlsMessage { /* private fields */ }

A MLS protocol message for sending data over the wire.

Implementations

impl MlsMessage

pub fn into_group_info(self) -> Option<GroupInfo>

pub fn as_group_info(&self) -> Option<&GroupInfo>

pub fn into_key_package(self) -> Option<KeyPackage>

pub fn wire_format(&self) -> WireFormat

The wire format value describing the contents of this message.

pub fn epoch(&self) -> Option<u64>

The epoch that this message belongs to.

Returns None if the message is WireFormat::KeyPackage or WireFormat::Welcome

pub fn cipher_suite(&self) -> Option<CipherSuite>

pub fn group_id(&self) -> Option<&[u8]>

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

Deserialize a message from transport.

pub fn to_bytes(&self) -> Result<Vec<u8>, MlsError>

Serialize a message for transport.

pub fn custom_proposals_by_value(&self) -> Vec<&CustomProposal>

If this is a plaintext commit message, return all custom proposals committed by value. If this is not a plaintext or not a commit, this returns an empty list.

pub fn welcome_key_package_references(&self) -> Vec<&KeyPackageRef>

If this is a welcome message, return key package references of all members who can join using this message.

pub fn key_package_reference<C: CipherSuiteProvider>( &self, cipher_suite: &C, ) -> Result<Option<KeyPackageRef>, MlsError>

If this is a key package, return its key package reference.

pub fn into_proposal_reference<C: CipherSuiteProvider>( self, cipher_suite: &C, ) -> Result<Option<Vec<u8>>, MlsError>

If this is a plaintext proposal, return the proposal reference that can be matched e.g. with StateUpdate::unused_proposals.

Trait Implementations

impl Clone for MlsMessage

fn clone(&self) -> MlsMessage

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MlsMessage

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

Formats the value using the given formatter.

impl MlsDecode for MlsMessage

fn mls_decode(reader: &mut &[u8]) -> Result<Self, Error>

impl MlsEncode for MlsMessage

fn mls_encode(&self, writer: &mut Vec<u8>) -> Result<(), Error>

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

impl MlsSize for MlsMessage

fn mls_encoded_len(&self) -> usize

impl PartialEq for MlsMessage

fn eq(&self, other: &MlsMessage) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<MlsMessage> for AddProposal

type Error = MlsError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl StructuralPartialEq for MlsMessage