Struct PoolBuilder

pub struct PoolBuilder { /* private fields */ }

A PoolBuilder can be used to create a Pool with custom configuration.

See Client for more information.

Examples

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

// ...

pool.close().await?;

Implementations

impl PoolBuilder

pub fn new() -> Self

Returns a new PoolBuilder 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 num_conns(self, num_conns: usize) -> Self

Specify the number of sqlite connections to open as part of the pool.

Defaults to the number of logical CPUs of the current system.

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

Returns a new Pool that uses the PoolBuilder configuration.

Examples

let pool = PoolBuilder::new().open().await?;

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

Returns a new Pool that uses the PoolBuilder configuration, blocking the current thread.

Examples

let pool = PoolBuilder::new().open_blocking()?;

Trait Implementations

impl Clone for PoolBuilder

fn clone(&self) -> PoolBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PoolBuilder

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

Formats the value using the given formatter.

impl Default for PoolBuilder

fn default() -> PoolBuilder

Returns the “default value” for a type.