Trait Entity 

pub trait Entity: PrimaryKey + Sized {
    const COLLECTION_NAME: &'static str;

    // Required methods
    fn get(
        conn: &Connection,
        key: &Self::PrimaryKey,
    ) -> CryptoKeystoreResult<Option<Self>>;
    fn count(conn: &Connection) -> CryptoKeystoreResult<u32>;
    fn load_all(conn: &Connection) -> CryptoKeystoreResult<Vec<Self>>;
}

Something which can be stored in our database.

It has a primary key, which uniquely identifies it.

Required Associated Constants

const COLLECTION_NAME: &'static str

The table name for this entity

Required Methods

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

Get an entity by its primary key.

For entites whose primary key has a distinct borrowed type, it is best to implement this as a direct passthrough:

fn get(conn: &Connection, key: &Self::PrimaryKey) -> CoreCryptoKeystoreResult<Option<Self>> {
    Self::get_borrowed(conn, key).await
}

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.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors

impl Entity for E2eiCrl

const COLLECTION_NAME: &'static str = "e2ei_crls"

impl Entity for E2eiIntermediateCert

const COLLECTION_NAME: &'static str = "e2ei_intermediate_certs"

impl Entity for MlsPendingMessage

const COLLECTION_NAME: &'static str = "mls_pending_messages"

impl Entity for PersistedMlsGroup

const COLLECTION_NAME: &'static str = "mls_groups"

impl Entity for PersistedMlsPendingGroup

const COLLECTION_NAME: &'static str = "mls_pending_groups"

impl Entity for ProteusIdentity

const COLLECTION_NAME: &'static str = "proteus_identities"

impl Entity for ProteusPrekey

const COLLECTION_NAME: &'static str = "proteus_prekeys"

impl Entity for ProteusSession

const COLLECTION_NAME: &'static str = "proteus_sessions"

impl Entity for StoredBufferedCommit

const COLLECTION_NAME: &'static str = "mls_buffered_commits"

impl Entity for StoredCredential

const COLLECTION_NAME: &'static str = "mls_credentials"

impl Entity for StoredEncryptionKeyPair

const COLLECTION_NAME: &'static str = "mls_encryption_keypairs"

impl Entity for StoredEpochEncryptionKeypair

const COLLECTION_NAME: &'static str = "mls_epoch_encryption_keypairs"

impl Entity for StoredHpkePrivateKey

const COLLECTION_NAME: &'static str = "mls_hpke_private_keys"

impl Entity for StoredKeypackage

const COLLECTION_NAME: &'static str = "mls_keypackages"

impl Entity for StoredPskBundle

const COLLECTION_NAME: &'static str = "mls_psk_bundles"

impl<T> Entity for T

where T: PrimaryKey + UniqueEntityImplementationHelper, <T as PrimaryKey>::PrimaryKey: ToSql,

const COLLECTION_NAME: &'static str = <Self as UniqueEntityImplementationHelper>::COLLECTION_NAME