Struct Database

pub struct Database { /* private fields */ }

A database connection

Implementations

impl Database

pub async fn open<P, S>( path: P, create_if_missing: bool, setup_func: S, ) -> Result<Self, Error>

where P: Into<PathBuf>, S: FnMut(&mut Connection) -> Result<(), BoxedError> + Send + 'static,

Open a database at the given path with the setup func.

pub fn blocking_open<P, S>( path: P, create_if_missing: bool, setup_func: S, ) -> Result<Self, Error>

where P: AsRef<Path>, S: FnMut(&mut Connection) -> Result<(), BoxedError> + Send + 'static,

Open a db in a blocking manner.

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

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

Access the database.

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

Close the db.

Commands will be able to be queued until this future completes. Then, all commands that come after will process, though new commands cannot be queued.

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

Join background thread.

This can only be called once. Future calls will fail. You should generally close the db connection before joining.

Trait Implementations

impl Clone for Database

fn clone(&self) -> Database

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Database

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

Formats the value using the given formatter.