CommitTimer

Struct CommitTimer 

Source
pub struct CommitTimer { /* private fields */ }
Expand description

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§

Source§

impl CommitTimer

Source

pub fn start(config: CommitConfig) -> Self

Start a new commit timer

Source

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

Check if a commit is due and try to perform it

Source

pub fn force_commit(&self)

Request an immediate forced commit

Source

pub fn is_commit_due(&self) -> bool

Check if a commit is currently due

Source

pub fn stop(&mut self)

Stop the timer

Source

pub fn is_running(&self) -> bool

Check if the timer is still running

Source§

impl CommitTimer

Source

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§

Source§

impl Drop for CommitTimer

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations§

Blanket Implementations§

§

impl<T> Any for T
where T: 'static + ?Sized,

§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<T> Borrow<T> for T
where T: ?Sized,

§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
§

impl<T> BorrowMut<T> for T
where T: ?Sized,

§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> From<T> for T

§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T, U> Into<U> for T
where U: From<T>,

§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.