Struct WalPool

pub struct WalPool { /* private fields */ }

A handle to a pool of connections, designed for a database in WAL mode.

Implementations

impl WalPool

pub fn builder() -> WalPoolBuilder

Get a builder for a WalPool.

pub async fn close(&self) -> Result<(), Error>

Close the pool.

This will queue a close request to each thread. When each thread processes the close request, it will shut down. When the last thread processed the close message, all current queued requests will be aborted.

When this function returns, the pool will be closed no matter the value of the return. The return value will return the last error that occured while closing.

pub async fn read<F, T>(&self, func: F) -> Result<T, Error>

where F: FnOnce(&mut Connection) -> T + Send + 'static, T: Send + 'static,

Access the database with a reader connection.

Note that dropping the returned future will not cancel the database access.

pub async fn write<F, T>(&self, func: F) -> Result<T, Error>

where F: FnOnce(&mut Connection) -> T + Send + 'static, T: Send + 'static,

Access the database with a writer connection.

Note that dropping the returned future will not cancel the database access.

Trait Implementations

impl Clone for WalPool

fn clone(&self) -> WalPool

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WalPool

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

Formats the value using the given formatter.