Struct MegolmMessage

pub struct MegolmMessage { /* private fields */ }

An encrypted Megolm message.

Contains metadata that is required to find the correct ratchet state of a InboundGroupSession necessary to decrypt the message.

Implementations

impl MegolmMessage

pub fn ciphertext(&self) -> &[u8]

The actual ciphertext of the message.

pub const fn message_index(&self) -> u32

The index of the message that was used when the message was encrypted.

pub fn mac(&self) -> &[u8]

Get the megolm message’s mac.

pub const fn signature(&self) -> &Ed25519Signature

Get a reference to the megolm message’s signature.

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

Try to decode the given byte slice as a MegolmMessage.

The expected format of the byte array is described in the MegolmMessage::to_bytes() method.

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

Encode the MegolmMessage as an array of bytes.

Megolm messages consist of a one byte version, followed by a variable length payload, a fixed length message authentication code, and a fixed length signature.

+---+------------------------------------+-----------+------------------+
| V | Payload Bytes                      | MAC Bytes | Signature Bytes  |
+---+------------------------------------+-----------+------------------+
0   1                                    N          N+8                N+72   bytes

The payload uses a format based on the Protocol Buffers encoding. It consists of the following key-value pairs:

Name	Tag	Type	Meaning
Message-Index	0x08	Integer	The index of the ratchet, i
Cipher-Text	0x12	String	The cipher-text, Xi, of the message

pub fn from_base64(message: &str) -> Result<Self, DecodeError>

Try to decode the given string as a MegolmMessage.

The string needs to be a base64 encoded byte array that follows the format described in the MegolmMessage::to_bytes() method.

pub fn to_base64(&self) -> String

Encode the MegolmMessage as a string.

This method first calls MegolmMessage::to_bytes() and then encodes the resulting byte array as a string using base64 encoding.

Trait Implementations

impl Clone for MegolmMessage

fn clone(&self) -> MegolmMessage

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MegolmMessage

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MegolmMessage

fn deserialize<D: Deserializer<'de>>(d: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl PartialEq for MegolmMessage

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

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&[u8]> for MegolmMessage

type Error = DecodeError

The type returned in the event of a conversion error.

fn try_from(message: &[u8]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&str> for MegolmMessage

type Error = DecodeError

The type returned in the event of a conversion error.

fn try_from(message: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Vec<u8>> for MegolmMessage

type Error = DecodeError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Eq for MegolmMessage

impl StructuralPartialEq for MegolmMessage