Struct Transaction

pub struct Transaction<'s, 'p> { /* private fields */ }

A transaction on a file store

Implementations

impl Transaction<'_, '_>

pub fn prepare( self, edits: impl IntoIterator<Item = RefEdit>, ref_files_lock_fail_mode: Fail, packed_refs_lock_fail_mode: Fail, ) -> Result<Self, Error>

Prepare for calling commit(…) in a way that can be rolled back perfectly.

If the operation succeeds, the transaction can be committed or dropped to cause a rollback automatically. Rollbacks happen automatically on failure and they tend to be perfect. This method is idempotent.

pub fn rollback(self) -> Vec<RefEdit>

Rollback all intermediate state and return the RefEdits as we know them thus far.

Note that they have been altered compared to what was initially provided as they have been split and know about their current state on disk.

Note

A rollback happens automatically as this instance is dropped as well.

impl Transaction<'_, '_>

pub fn commit<'a>( self, committer: impl Into<Option<SignatureRef<'a>>>, ) -> Result<Vec<RefEdit>, Error>

Make all prepared permanent and return the performed edits which represent the current state of the affected refs in the ref store in that instant. Please note that the obtained edits may have been adjusted to contain more dependent edits or additional information. committer is used in the reflog and only if the reflog is actually written, which is why it is optional. Please note that if None is passed and the reflog needs to be written, the operation will be aborted late and a few refs may have been successfully committed already, making clear the non-atomic nature of multi-file edits.

On error the transaction may have been performed partially, depending on the nature of the error, and no attempt to roll back partial changes is made.

In this stage, we perform the following operations:

• update the ref log
• move updated refs into place
• delete reflogs and empty parent directories
• delete packed refs
• delete their corresponding reference (if applicable) along with empty parent directories

Note that transactions will be prepared automatically as needed.

impl<'p> Transaction<'_, 'p>

pub fn packed_refs(self, packed_refs: PackedRefs<'p>) -> Self

Configure the way packed refs are handled during the transaction

Trait Implementations

impl Debug for Transaction<'_, '_>

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

Formats the value using the given formatter.