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

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>

Implementations§

source§

impl ContextBuilder

source

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.

source

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.

source

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.

source

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.

source

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.

source

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

Opens the Context.

Trait Implementations§

source§

impl Clone for ContextBuilder

source§

fn clone(&self) -> ContextBuilder

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for ContextBuilder

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

§

fn implicit( self, class: Class, constructed: bool, tag: u32 ) -> TaggedParser<'a, Implicit, Self, E>

source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more