Struct Message

pub struct Message { /* private fields */ }

An encrypted Olm message.

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

Implementations

impl Message

pub const fn ratchet_key(&self) -> Curve25519PublicKey

The public part of the ratchet key, that was used when the message was encrypted.

pub const fn chain_index(&self) -> u64

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

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

The actual ciphertext of the message.

pub const fn version(&self) -> u8

The version of the Olm message.

pub const fn mac_truncated(&self) -> bool

Has the MAC been truncated in this Olm message.

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

Try to decode the given byte slice as a Olm Message.

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

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

Encode the Message as an array of bytes.

Olm Messages consist of a one-byte version, followed by a variable length payload and a fixed length message authentication code.

+--------------+------------------------------------+-----------+
| Version Byte | Payload Bytes                      | MAC Bytes |
+--------------+------------------------------------+-----------+

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

Name	Tag	Type	Meaning
Ratchet-Key	0x0A	String	The public part of the ratchet key
Chain-Index	0x10	Integer	The chain index, of the message
Cipher-Text	0x22	String	The cipher-text of the message

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

Try to decode the given string as a Olm Message.

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

pub fn to_base64(&self) -> String

Encode the Message as a string.

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

Trait Implementations

impl Clone for Message

fn clone(&self) -> Message

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Message

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Message

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

Deserialize this value from the given Serde deserializer.

impl From<Message> for OlmMessage

fn from(m: Message) -> Self

Converts to this type from the input type.

impl PartialEq for Message

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

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 Message

type Error = DecodeError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&str> for Message

type Error = DecodeError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Vec<u8>> for Message

type Error = DecodeError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Eq for Message

impl StructuralPartialEq for Message