Struct SessionConfig

pub struct SessionConfig<'a> {
    pub db_connection_type: ConnectionType<'a>,
    pub database_key: DatabaseKey,
    pub client_id: Option<ClientId>,
    pub external_entropy: Option<&'a [u8]>,
    pub ciphersuites: Vec<MlsCiphersuite>,
    pub nb_key_packages: Option<usize>,
}

Configuration parameters for Session

These can be set directly or via the builder.

Fields

db_connection_type: ConnectionType<'a>

Connection type for the database

database_key: DatabaseKey

Database key to be used to instantiate the MlsCryptoProvider

client_id: Option<ClientId>

Identifier for the client to be used by Session

If set, this initializes the MLS session. Otherwise, the session is left uninitialized.

external_entropy: Option<&'a [u8]>

Entropy pool seed for the internal PRNG

ciphersuites: Vec<MlsCiphersuite>

All supported ciphersuites in this session

nb_key_packages: Option<usize>

Number of openmls::prelude::KeyPackage to create when creating a MLS client.

Defaults to crate::prelude::INITIAL_KEYING_MATERIAL_COUNT.

Implementations

impl<'a> SessionConfig<'a>

pub fn builder() -> SessionConfigBuilder<'a, ((), (), (), (), (), ())>

Create a builder for building SessionConfig. On the builder, call .db_connection_type(...), .database_key(...), .client_id(...)(optional), .external_entropy(...)(optional), .ciphersuites(...)(optional), .nb_key_packages(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of SessionConfig.

impl<'a> SessionConfig<'a>

pub fn validate(self) -> Result<ValidatedSessionConfig<'a>>

Validate this configuration to produce a validated configuration.

This can then be passed to Session::try_new.

Trait Implementations

impl<'a> Clone for SessionConfig<'a>

fn clone(&self) -> SessionConfig<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for SessionConfig<'a>

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

Formats the value using the given formatter.

impl<'a> TryFrom<SessionConfig<'a>> for ValidatedSessionConfig<'a>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: SessionConfig<'a>) -> Result<Self, Self::Error>

Performs the conversion.