Struct olm_rs::session::OlmSession

pub struct OlmSession { /* fields omitted */ }

Either an outbound or inbound session for secure communication.

Implementations

impl OlmSession

pub fn session_id(&self) -> String

Retuns the identifier for this session. Will be the same for both ends of the conversation.

C-API equivalent

olm_session_id

Panics

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

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

Serialises an OlmSession to encrypted base64.

C-API equivalent

olm_pickle_session

Panics

• OUTPUT_BUFFER_TOO_SMALL for OlmSession’s pickled buffer
• on malformed UTF-8 coding of the pickling provided by libolm

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

Deserialises from encrypted base64 that was previously obtained by pickling an OlmSession.

C-API equivalent

olm_unpickle_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) -> OlmMessage

Encrypts a plaintext message using the session.

C-API equivalent

• olm_encrypt

Panics

• NotEnoughRandom for too little supplied random data
• OutputBufferTooSmall for encrypted message
• on malformed UTF-8 coding of the ciphertext provided by libolm

pub fn decrypt(&self, message: OlmMessage) -> Result<String, OlmSessionError>

Decrypts a message using this session. Decoding is lossy, meaing if the decrypted plaintext contains invalid UTF-8 symbols, they will be returned as U+FFFD (�).

C-API equivalent

olm_decrypt

Errors

• InvalidBase64 on invalid base64 coding for supplied arguments
• BadMessageVersion on unsupported protocol version
• BadMessageFormat on failing to decode the message
• BadMessageMac on invalid message MAC

Panics

• OutputBufferTooSmall on plaintext output buffer

pub fn has_received_message(&self) -> bool

Checker for any received messages for this session.

C-API equivalent

olm_session_has_received_message

pub fn matches_inbound_session(
    &self,
    message: PreKeyMessage
) -> Result<bool, OlmSessionError>

Checks if the ‘prekey’ message is for this in-bound session.

C-API equivalent

olm_matches_inbound_session

Errors

• InvalidBase64 for failing to decode base64 in one_time_key_message
• BadMessageVersion for message from unsupported protocol version
• BadMessageFormat for failing to decode one_time_key_message

pub fn matches_inbound_session_from(
    &self,
    their_identity_key: &str,
    message: PreKeyMessage
) -> Result<bool, OlmSessionError>

Checks if the ‘prekey’ message is for this in-bound session.

C-API equivalent

olm_matches_inbound_session

Errors

• InvalidBase64 for failing to decode base64 in one_time_key_message
• BadMessageVersion for message from unsupported protocol version
• BadMessageFormat for failing to decode one_time_key_message

Trait Implementations

impl Debug for OlmSession

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

Formats the value using the given formatter.

impl Drop for OlmSession

fn drop(&mut self)

Executes the destructor for this type.

impl Ord for OlmSession

orders by unicode code points (which is a superset of ASCII)

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<OlmSession> for OlmSession

fn eq(&self, other: &Self) -> 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 !=.

impl PartialOrd<OlmSession> for OlmSession

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for OlmSession

impl Send for OlmSession