Struct Transaction

pub struct Transaction { /* private fields */ }

An in-memory representation of a repo and any changes being made to it.

Within the scope of a transaction, changes to the repository are made in-memory to mut_repo and published to the repo backend when Transaction::commit is called. When a transaction is committed, it becomes atomically visible as an Operation in the op log that represents the transaction itself, and as a View that represents the state of the repo after the transaction. This is similar to how a Commit represents a change to the contents of the repository and a Tree represents the repository’s contents after the change. See the documentation for op_store::Operation and op_store::View for more information.

Implementations

impl Transaction

pub fn new(mut_repo: MutableRepo, user_settings: &UserSettings) -> Transaction

pub fn base_repo(&self) -> &Arc<ReadonlyRepo>

pub fn set_tag(&mut self, key: String, value: String)

pub fn repo(&self) -> &MutableRepo

pub fn repo_mut(&mut self) -> &mut MutableRepo

pub fn merge_operation( &mut self, other_op: Operation, ) -> Result<(), RepoLoaderError>

pub fn set_is_snapshot(&mut self, is_snapshot: bool)

pub fn commit( self, description: impl Into<String>, ) -> Result<Arc<ReadonlyRepo>, TransactionCommitError>

Writes the transaction to the operation store and publishes it.

pub fn write( self, description: impl Into<String>, ) -> Result<UnpublishedOperation, TransactionCommitError>

Writes the transaction to the operation store, but does not publish it. That means that a repo can be loaded at the operation, but the operation will not be seen when loading the repo at head.