Struct PersistedMlsGroup 

pub struct PersistedMlsGroup {
    pub id: ConversationId,
    pub state: Vec<u8>,
    pub epoch: u64,
    pub ciphersuite: u16,
    pub credential_id: Sha256Hash,
    pub credential_type: u16,
    pub own_leaf_index: u32,
    pub is_pending: bool,
    pub tnt_tx_counter: u32,
}

Entity representing a persisted MlsGroup

Fields

id: ConversationId

state: Vec<u8>

epoch: u64

ciphersuite: u16

credential_id: Sha256Hash

Hash of the public key of the credential currently in use by our leaf node, if one can be determined. None if the group’s leaf node has been removed, or if that credential is no longer present in mls_credentials.

credential_type: u16

The type of the credential identified by credential_id. mls_credentials’s primary key is (public_key_sha256, credential_type), not public_key_sha256 alone, so this always travels alongside credential_id: both are Some or both are None.

own_leaf_index: u32

is_pending: bool

Distinguishes a group joined by external commit but not yet merged from an established one.

tnt_tx_counter: u32

Counter for outbound TNT messages

Implementations

impl PersistedMlsGroup

pub fn delete_if_pending<'a, Tx>( tx: &'a Tx, id: &ConversationIdRef, ) -> CryptoKeystoreResult<bool>

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

Delete this group only if it is still marked pending.

A pending group and the established group it eventually becomes share a row. Abandoning a pending join must not delete an established group which has since superseded it. This accomplishes that while avoiding TOCTOU issues.

Trait Implementations

impl BorrowPrimaryKey for PersistedMlsGroup

type BorrowedPrimaryKey<'a> = &'a ConversationIdRef

fn borrow_primary_key(&self) -> Self::BorrowedPrimaryKey<'_>

Borrow this entity’s primary key without copying any data.

impl Clone for PersistedMlsGroup

fn clone(&self) -> PersistedMlsGroup

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PersistedMlsGroup

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PersistedMlsGroup

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Drop for PersistedMlsGroup

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl Entity for PersistedMlsGroup

const TABLE_NAME: &'static str = "mls_groups"

The name of the SQL table for this entity

fn get( conn: &Connection, key: &Self::PrimaryKey, ) -> 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 PersistedMlsGroup

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, id: &ConversationId) -> CryptoKeystoreResult<bool>

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

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

impl EntityDeleteBorrowed for PersistedMlsGroup

fn delete_borrowed<'a, Tx>( tx: &'a Tx, id: &ConversationIdRef, ) -> CryptoKeystoreResult<bool>

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

Delete an entity by a borrowed form of its primary key.

impl EntityGetBorrowed for PersistedMlsGroup

fn get_borrowed( conn: &Connection, key: Self::BorrowedPrimaryKey<'_>, ) -> CryptoKeystoreResult<Option<Self>>

Get an entity by a borrowed form of its primary key.

impl Eq for PersistedMlsGroup

impl PartialEq for PersistedMlsGroup

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

type PrimaryKey = ConversationId

Each distinct PrimaryKey uniquely identifies either 0 or 1 instance.

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

Get this entity’s primary key.

impl Serialize for PersistedMlsGroup

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 PersistedMlsGroup

impl ToValue for PersistedMlsGroup

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

Perform the conversion.