Struct MlsPendingMessage 

pub struct MlsPendingMessage {
    pub conversation_id: ConversationId,
    pub message: Vec<u8>,
}

Entity representing a buffered message

A message is buffered when it cannot be decrypted yet, which happens in two unrelated situations: the conversation was joined by external commit and that join has not been merged, or the conversation is fully established but the message belongs to epoch n + 1 while we are still in epoch n. Both kinds of conversation are rows in mls_groups, but a message can arrive and be buffered before its conversation is persisted, so conversation_id holds no foreign key.

This entity cannot be updated in the DB: the primary key is formed of a hash of all the rest of the data, so duplicate save attempts silently succeed without changing anything.

Fields

conversation_id: ConversationId

Note that in SQL we do not have a foreign key constraint from conversation_id to the group table. This is because we can’t avoid the possibility of out-of-order delivery from the DS. If we receive a pending message from a group that we haven’t joined yet, followed by the commit which adds us to that group, then we need to still store that message, and that means that a foreign key would be inappropriate here.

message: Vec<u8>

Trait Implementations

impl Clone for MlsPendingMessage

fn clone(&self) -> MlsPendingMessage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MlsPendingMessage

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

Formats the value using the given formatter.

impl DeletableBySearchKey<ConversationId> for MlsPendingMessage

fn delete_all_matching<'a, Tx>( tx: &'a Tx, conversation_id: &ConversationId, ) -> CryptoKeystoreResult<()>

where &'a Tx: Into<Transactionlike<'a>>,

Delete all entities matching the search key.

impl DeletableBySearchKey<ConversationIdRef> for MlsPendingMessage

fn delete_all_matching<'a, Tx>( tx: &'a Tx, conversation_id: &ConversationIdRef, ) -> CryptoKeystoreResult<()>

where &'a Tx: Into<Transactionlike<'a>>,

Delete all entities matching the search key.

impl<'de> Deserialize<'de> for MlsPendingMessage

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Entity for MlsPendingMessage

const TABLE_NAME: &'static str = "mls_pending_messages"

The name of the SQL table for this entity

fn get( conn: &Connection, key: &Sha256Hash, ) -> CryptoKeystoreResult<Option<Self>>

Get an entity by its primary key.

fn count(conn: &Connection) -> CryptoKeystoreResult<u32>

Count the number of entities of this type in the database.

fn load_all(conn: &Connection) -> CryptoKeystoreResult<Vec<Self>>

Retrieve all entities of this type from the database.

impl EntityDatabaseMutation for MlsPendingMessage

fn save<'a, Tx>(&self, tx: &'a Tx) -> CryptoKeystoreResult<()>

where &'a Tx: Into<Transactionlike<'a>>,

Save this entity to the database in the context of this transaction.

fn delete<'a, Tx>( tx: &'a Tx, primary_key: &Sha256Hash, ) -> CryptoKeystoreResult<bool>

where &'a Tx: Into<Transactionlike<'a>>,

Use the transaction’s inteface to delete this entity from the database.

impl Eq for MlsPendingMessage

impl PartialEq for MlsPendingMessage

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

type PrimaryKey = Sha256Hash

Each distinct PrimaryKey uniquely identifies either 0 or 1 instance.

fn primary_key(&self) -> Self::PrimaryKey

Get this entity’s primary key.

impl SearchableEntity<ConversationId> for MlsPendingMessage

fn find_all_matching( conn: &Connection, conversation_id: &ConversationId, ) -> CryptoKeystoreResult<Vec<Self>>

Find all entities matching the search key.

fn matches(&self, conversation_id: &ConversationId) -> bool

true when this entity instance matches the search key.

impl SearchableEntity<ConversationIdRef> for MlsPendingMessage

fn find_all_matching( conn: &Connection, conversation_id: &ConversationIdRef, ) -> CryptoKeystoreResult<Vec<Self>>

Find all entities matching the search key.

fn matches(&self, conversation_id: &ConversationIdRef) -> bool

true when this entity instance matches the search key.

impl Serialize for MlsPendingMessage

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for MlsPendingMessage

impl ToValue for MlsPendingMessage

fn to_value(&self) -> Value<'_>

Perform the conversion.

impl Zeroize for MlsPendingMessage

fn zeroize(&mut self)

Zero out this object from memory using Rust intrinsics which ensure the zeroization operation is not “optimized away” by the compiler.