Struct DbOpts 

pub struct DbOpts {
    pub prefix: String,
    pub key: Option<String>,
    pub migration: MigrationConfirmation,
}

Database options for a SimpleX chat instance.

The prefix field

SimpleX stores each chat instance as a set of files sharing a common path prefix. The prefix is a directory path plus a filename stem: the directory part is created if absent, and the stem is prepended to every database filename.

prefix: "data/bot" - creates ./data/bot_agent.db, ./data/bot_chat.db
prefix: "bot" - creates ./bot_agent.db, ./bot_chat.db

Warning: overlapping prefixes

Two instances whose prefixes share the same directory and stem will silently read and write the same files. This will produce DB errors and may cause DB corruptions

Fields

prefix: String

key: Option<String>

migration: MigrationConfirmation

Implementations

impl DbOpts

pub fn unencrypted<P: AsRef<Path>>(db_path: P) -> Self

Open an unencrypted SimpleX database at the given path prefix.

See DbOpts for an explanation of what prefix means and the overlap warning.

pub fn encrypted<P: AsRef<Path>, K: Into<String>>(prefix: P, key: K) -> Self

Open an encrypted SimpleX database at the given path prefix with the given passphrase.

See DbOpts for an explanation of what prefix means and the overlap warning.

Trait Implementations

impl Clone for DbOpts

fn clone(&self) -> DbOpts

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DbOpts

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

Formats the value using the given formatter.