Struct matrix_sdk_crypto::olm::InboundGroupSession

pub struct InboundGroupSession { /* fields omitted */ }

Inbound group session.

Inbound group sessions are used to exchange room messages between a group of participants. Inbound group sessions are used to decrypt the room messages.

Implementations

impl InboundGroupSession

pub fn from_export(
    exported_session: impl Into<ExportedRoomKey>
) -> Result<Self, OlmGroupSessionError>

Create a InboundGroupSession from an exported version of the group session.

Most notably this can be called with an ExportedRoomKey from a previous export() call.

pub async fn pickle(
    &self,
    pickle_mode: PicklingMode
) -> PickledInboundGroupSession

Store the group session as a base64 encoded string.

Arguments

• pickle_mode - The mode that was used to pickle the group session, either an unencrypted mode or an encrypted using passphrase.

pub async fn export(&self) -> ExportedRoomKey

Export this session at the first known message index.

If only a limited part of this session should be exported use export_at_index().

pub fn sender_key(&self) -> &str

Get the sender key that this session was received from.

pub fn signing_keys(&self) -> &BTreeMap<DeviceKeyAlgorithm, String>

Get the map of signing keys this session was received from.

pub fn forwarding_key_chain(&self) -> &[String]

Get the list of ed25519 keys that this session was forwarded through.

Each ed25519 key represents a single device. If device A forwards the session to device B and device B to C this list will contain the ed25519 keys of A and B.

pub async fn export_at_index(&self, message_index: u32) -> ExportedRoomKey

Export this session at the given message index.

pub fn from_pickle(
    pickle: PickledInboundGroupSession,
    pickle_mode: PicklingMode
) -> Result<Self, OlmGroupSessionError>

Restore a Session from a previously pickled string.

Returns the restored group session or a OlmGroupSessionError if there was an error.

Arguments

• pickle - The pickled version of the InboundGroupSession.

• pickle_mode - The mode that was used to pickle the session, either an unencrypted mode or an encrypted using passphrase.

pub fn room_id(&self) -> &RoomId

The room where this session is used in.

pub fn session_id(&self) -> &str

Returns the unique identifier for this session.

pub fn first_known_index(&self) -> u32

Get the first message index we know how to decrypt.

Trait Implementations

impl Clone for InboundGroupSession

fn clone(&self) -> InboundGroupSession

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for InboundGroupSession

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

Formats the value using the given formatter.

impl PartialEq<InboundGroupSession> for InboundGroupSession

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 TryFrom<ExportedRoomKey> for InboundGroupSession

type Error = OlmGroupSessionError

The type returned in the event of a conversion error.

fn try_from(key: ExportedRoomKey) -> Result<Self, Self::Error>

Performs the conversion.