Struct olm_rs::outbound_group_session::OlmOutboundGroupSession

pub struct OlmOutboundGroupSession { /* fields omitted */ }

An out-bound group session is responsible for encrypting outgoing communication in a Megolm session.

Implementations

impl OlmOutboundGroupSession

pub fn new() -> Self

Creates a new instance of OlmOutboundGroupSession.

C-API equivalent

olm_init_outbound_group_session

Panics

• NotEnoughRandom for creation

pub fn pickle(&self, mode: PicklingMode) -> String

Serialises an OlmOutboundGroupSession to encrypted Base64.

C-API equivalent

olm_pickle_outbound_group_session

Panics

• OutputBufferTooSmall for pickled buffer
• on malformed UTF-8 coding of the pickling provided by libolm

pub fn unpickle(
    pickled: String,
    mode: PicklingMode
) -> Result<Self, OlmGroupSessionError>

Deserialises from encrypted Base64 that was previously obtained by pickling an OlmOutboundGroupSession.

C-API equivalent

olm_unpickle_outbound_group_session

Errors

• BadAccountKey if the key doesn’t match the one the session was encrypted with
• InvalidBase64 if decoding the supplied pickled string slice fails

pub fn encrypt(&self, plaintext: &str) -> String

Encrypts a plaintext message using the session.

C-API equivalent

• olm_group_encrypt

Panics

• OutputBufferTooSmall for encrypted message
• on malformed UTF-8 coding of the ciphertext provided by libolm

pub fn session_message_index(&self) -> u32

Get the current message index for this session.

Each message is sent with an increasing index; this returns the index for the next message.

C-API equivalent

• olm_outbound_group_session_message_index

pub fn session_id(&self) -> String

Get a base64-encoded identifier for this session.

C-API equivalent

• olm_outbound_group_session_id

Panics

• OutputBufferTooSmall for too small ID buffer
• on malformed UTF-8 coding of the session ID provided by libolm

pub fn session_key(&self) -> String

Get the base64-encoded current ratchet key for this session.

Each message is sent with a different ratchet key. This function returns the ratchet key that will be used for the next message.

C-API equivalent

• olm_outbound_group_session_key

Panics

• OutputBufferTooSmall for too small session key buffer
• on malformed UTF-8 coding of the session key provided by libolm

Trait Implementations

impl Default for OlmOutboundGroupSession

fn default() -> Self

Returns the “default value” for a type.

impl Drop for OlmOutboundGroupSession

fn drop(&mut self)

Executes the destructor for this type.

impl Send for OlmOutboundGroupSession