Struct WalCheckpointJob 

pub struct WalCheckpointJob { /* private fields */ }

A checkpoint job for one database. Share it by reference; it holds no connection.

Implementations

impl WalCheckpointJob

pub fn new(db: impl AsRef<Path>, policy: WalCheckpointPolicy) -> Result<Self>

A job for the database at db, idle from now.

pub fn policy(&self) -> WalCheckpointPolicy

The policy this job was built with.

pub fn note_activity(&self)

Records that the database was used now. Call it on every use; a RESTART needs the database to have been idle for quiet_for.

pub fn note_activity_at(&self, now: Instant)

Self::note_activity at now, for callers that keep their own clock.

pub fn tick(&self, conn: &Connection) -> Result<Option<WalCheckpointRun>>

Runs the checkpoint due now on conn, the writer for this database, if the policy calls for one. Ok(None) when nothing is due or another tick is still running.

pub fn tick_at( &self, conn: &Connection, now: Instant, ) -> Result<Option<WalCheckpointRun>>

Self::tick at now, for callers that keep their own clock.

Trait Implementations

impl Debug for WalCheckpointJob

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

Formats the value using the given formatter.