Struct CheckpointReport 

pub struct CheckpointReport {
    pub busy: bool,
    pub log_frames: u64,
    pub checkpointed_frames: u64,
}

What PRAGMA wal_checkpoint returned (0.12.13, W5.2, D-156).

The three columns SQLite gives back, named, rather than () — a checkpoint that did nothing and a checkpoint that reclaimed a 400 MB WAL are the same Ok(()), and the difference is the entire reason a caller asked.

Fields

busy: bool

true when SQLite could not complete the requested mode because a reader or writer was in the way.

This is not an error, and it is not ignorable. TRUNCATE waits for readers only as long as busy_timeout allows; past that it gives up and says so, having possibly still copied frames. A caller checkpointing before copying the file away must read this, because a busy checkpoint means the main file is not self-contained yet.

log_frames: u64

Frames left in the WAL at the end. 0 when the checkpoint completed, since the mode run is TRUNCATE.

checkpointed_frames: u64

Frames moved back into the database file.

Read from a FULL pass rather than from the TRUNCATE — see run_checkpoint for why a truncating checkpoint cannot report this number itself.

Implementations

impl CheckpointReport

pub fn is_complete(&self) -> bool

The WAL was fully reclaimed: nothing blocked, and nothing is left.

Trait Implementations

impl Clone for CheckpointReport

fn clone(&self) -> CheckpointReport

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for CheckpointReport

impl Debug for CheckpointReport

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

Formats the value using the given formatter.

impl Eq for CheckpointReport

impl PartialEq for CheckpointReport

fn eq(&self, other: &CheckpointReport) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for CheckpointReport