Struct LazyDb

pub struct LazyDb<CI> { /* private fields */ }

Lazily-loaded database with interruption support

In addition to the Self::interrupt method, LazyDb also calls [interrupt_support::register_interrupt] on any opened database. This means that if [interrupt_support::shutdown] is called it will interrupt this database if it’s open and in-use.

Implementations

impl<CI: ConnectionInitializer> LazyDb<CI>

pub fn new( path: &Path, open_flags: OpenFlags, connection_initializer: CI, ) -> Self

Create a new LazyDb

This does not open the connection and is non-blocking

pub fn lock( &self, ) -> Result<(MappedMutexGuard<'_, Connection>, SqlInterruptScope), Error>

Lock the database mutex and get a connection and interrupt scope.

If the connection is closed, it will be opened.

Calling lock again, or calling close, from the same thread while the mutex guard is still alive will cause a deadlock.

pub fn close(&self, interrupt: bool)

Close the database if it’s open

Pass interrupt=true to interrupt any in-progress queries before closing the database.

Do not call close if you already have a lock on the database in the current thread, as this will cause a deadlock.

pub fn interrupt(&self)

Interrupt any in-progress queries