Struct interrupt_support::SqlInterruptHandle

pub struct SqlInterruptHandle { /* private fields */ }

Interrupt operations that use SQL

Typical usage of this type:

• Components typically create a wrapper class around an rusqlite::Connection (PlacesConnection, LoginStore, etc.)
• The wrapper stores an Arc<SqlInterruptHandle>
• The wrapper has a method that clones and returns that Arc. This allows passing the interrupt handle to a different thread in order to interrupt a particular operation.
• The wrapper calls begin_interrupt_scope() at the start of each operation. The code that performs the operation periodically calls err_if_interrupted().
• Finally, the wrapper class implements AsRef<SqlInterruptHandle> and calls register_interrupt(). This causes all operations to be interrupted when we enter shutdown mode.

Implementations

impl SqlInterruptHandle

pub fn new(conn: &Connection) -> Self

pub fn begin_interrupt_scope(&self) -> Result<SqlInterruptScope, Interrupted>

Begin an interrupt scope that will be interrupted by this handle

Returns Err(Interrupted) if we’re in shutdown mode

pub fn interrupt(&self)

Interrupt all interrupt scopes created by this handle

Trait Implementations

impl AsRef<SqlInterruptHandle> for SqlInterruptHandle

fn as_ref(&self) -> &SqlInterruptHandle

Converts this type into a shared reference of the (usually inferred) input type.

impl Debug for SqlInterruptHandle

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

Formats the value using the given formatter.