Struct ClientBuilder 

pub struct ClientBuilder { /* private fields */ }

A ClientBuilder can be used to create a Client with custom configuration.

For more information on creating a sqlite connection, see the rusqlite docs.

Examples

let client = ClientBuilder::new().path("path/to/db.sqlite3").open().await?;

// ...

client.close().await?;

Implementations

impl ClientBuilder

pub fn new() -> Self

Returns a new ClientBuilder with the default settings.

pub fn path<P: AsRef<Path>>(self, path: P) -> Self

Specify the path of the sqlite3 database to open.

By default, an in-memory database is used.

pub fn flags(self, flags: OpenFlags) -> Self

Specify the OpenFlags to use when opening a new connection.

By default, OpenFlags::default() is used.

pub fn journal_mode(self, journal_mode: JournalMode) -> Self

Specify the JournalMode to set when opening a new connection.

By default, no journal_mode is explicity set.

pub fn vfs(self, vfs: &str) -> Self

Specify the name of the vfs to use.

pub fn queue_capacity(self, queue_capacity: usize) -> Self

Limit the number of commands that may wait in the worker queue.

By default, the queue is unbounded. If a capacity is configured, calls return Error::QueueFull when that many commands are already waiting for the worker thread. A capacity of 0 allows a command to be accepted only when the worker is ready to receive it immediately.

pub async fn open(self) -> Result<Client, Error>

Returns a new Client that uses the ClientBuilder configuration.

Examples

let client = ClientBuilder::new().open().await?;

pub fn open_blocking(self) -> Result<Client, Error>

Returns a new Client that uses the ClientBuilder configuration, blocking the current thread.

Examples

let client = ClientBuilder::new().open_blocking()?;

Trait Implementations

impl Clone for ClientBuilder

fn clone(&self) -> ClientBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ClientBuilder

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

Formats the value using the given formatter.

impl Default for ClientBuilder

fn default() -> ClientBuilder

Returns the “default value” for a type.