Struct deltachat::context::ContextBuilder

pub struct ContextBuilder {
    dbfile: PathBuf,
    id: u32,
    events: Events,
    stock_strings: StockStrings,
    password: Option<String>,
    push_subscriber: Option<PushSubscriber>,
}

Builder for the Context.

Many arguments to the Context are kind of optional and only needed to handle multiple contexts, for which the account manager should be used. This builder makes creating a new context simpler, especially for the standalone-context case.

Examples

Creating a new unencrypted database:

use deltachat::context::ContextBuilder;

let dir = tempfile::tempdir().unwrap();
let context = ContextBuilder::new(dir.path().join("db"))
     .open()
     .await
     .unwrap();
drop(context);

To use an encrypted database provide a password. If the database does not yet exist it will be created:

use deltachat::context::ContextBuilder;

let dir = tempfile::tempdir().unwrap();
let context = ContextBuilder::new(dir.path().join("db"))
     .with_password("secret".into())
     .open()
     .await
     .unwrap();
drop(context);

Fields

dbfile: PathBuf

id: u32

events: Events

stock_strings: StockStrings

password: Option<String>

push_subscriber: Option<PushSubscriber>

Implementations

impl ContextBuilder

pub fn new(dbfile: PathBuf) -> Self

Create the builder using the given database file.

The dbfile should be in a dedicated directory and this directory must exist. The Context will create other files and folders in the same directory as the database file used.

pub fn with_id(self, id: u32) -> Self

Sets the context ID.

This identifier is used e.g. in Events to identify which Context an event belongs to. The only real limit on it is that it should not conflict with any other Contexts you currently have open. So if you handle multiple Contexts you may want to use this.

Note that the account manager is designed to handle the common case for using multiple Context instances.

pub fn with_events(self, events: Events) -> Self

Sets the event channel for this Context.

Mostly useful when using multiple Contexts, this allows creating one Events channel and passing it to all Contexts so all events are received on the same channel.

Note that the account manager is designed to handle the common case for using multiple Context instances.

pub fn with_stock_strings(self, stock_strings: StockStrings) -> Self

Sets the StockStrings map to use for this Context.

This is useful in order to share the same translation strings in all Contexts. The mapping may be empty when set, it will be populated by [Context::set_stock-translation] or Accounts::set_stock_translation calls.

Note that the account manager is designed to handle the common case for using multiple Context instances.

pub fn with_password(self, password: String) -> Self

Sets the password to unlock the database.

If an encrypted database is used it must be opened with a password. Setting a password on a new database will enable encryption.

pub(crate) fn with_push_subscriber( self, push_subscriber: PushSubscriber ) -> Self

Sets push subscriber.

pub async fn build(self) -> Result<Context>

Builds the Context without opening it.

pub async fn open(self) -> Result<Context>

Builds the Context and opens it.

Returns error if context cannot be opened with the given passphrase.

Trait Implementations

impl Clone for ContextBuilder

fn clone(&self) -> ContextBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ContextBuilder

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

Formats the value using the given formatter.