Struct CommitTimer 

pub struct CommitTimer { /* private fields */ }

A timer that signals when commits are due.

This runs a background thread that sets a flag when the commit interval elapses. The actual commit must be performed by calling try_commit() with the repository.

Implementations

impl CommitTimer

pub fn start(config: CommitConfig) -> Self

Start a new commit timer

pub fn try_commit( &self, staging: &Staging, repo: &Repository, ) -> FsResult<Option<String>>

Check if a commit is due and try to perform it

pub fn force_commit(&self)

Request an immediate forced commit

pub fn is_commit_due(&self) -> bool

Check if a commit is currently due

pub fn stop(&mut self)

Stop the timer

pub fn is_running(&self) -> bool

Check if the timer is still running

impl CommitTimer

pub fn start_legacy( _staging: Staging, _repo: Arc<Repository>, config: CommitConfig, ) -> FsResult<Self>

Start a new commit worker (delegates to CommitTimer)

Note: The repo parameter is ignored as commits happen synchronously. Use try_commit() or commit_now() to perform actual commits.

Trait Implementations

impl Drop for CommitTimer

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.