Enum OlmMessage

pub enum OlmMessage {
    Normal(Message),
    PreKey(PreKeyMessage),
}

Enum over the different Olm message types.

Olm uses two types of messages. The underlying transport protocol must provide a means for recipients to distinguish between them.

OlmMessage provides Serialize and Deserialize implementations that are compatible with Matrix.

Variants

Normal(Message)

A normal message, contains only the ciphertext and metadata to decrypt it.

PreKey(PreKeyMessage)

A pre-key message, contains metadata to establish a Session as well as a Message.

Implementations

impl OlmMessage

pub fn from_parts( message_type: usize, ciphertext: &[u8], ) -> Result<Self, DecodeError>

Create an OlmMessage from a message type and a ciphertext.

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

Get the message’s ciphertext as a byte array.

pub const fn message_type(&self) -> MessageType

Get the type of the message.

pub fn to_parts(&self) -> (usize, Vec<u8>)

Convert the OlmMessage into a message type, and ciphertext bytes tuple.

Trait Implementations

impl Clone for OlmMessage

fn clone(&self) -> OlmMessage

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OlmMessage

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for OlmMessage

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 From<PreKeyMessage> for OlmMessage

fn from(m: PreKeyMessage) -> Self

Converts to this type from the input type.

impl PartialEq for OlmMessage

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

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for OlmMessage

impl StructuralPartialEq for OlmMessage