Struct WorkspaceCommandTransaction

pub struct WorkspaceCommandTransaction<'a> { /* private fields */ }

An ongoing Transaction tied to a particular workspace.

WorkspaceCommandTransactions are created with WorkspaceCommandHelper::start_transaction and committed with WorkspaceCommandTransaction::finish. The inner Transaction can also be extracted using WorkspaceCommandTransaction::into_inner in situations where finer-grained control over the Transaction is necessary.

Implementations

impl WorkspaceCommandTransaction<'_>

pub fn base_workspace_helper(&self) -> &WorkspaceCommandHelper

Workspace helper that may use the base repo.

pub fn settings(&self) -> &UserSettings

Settings for this workspace.

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

pub fn repo(&self) -> &MutableRepo

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

pub fn check_out( &mut self, commit: &Commit, ) -> Result<Commit, CheckOutCommitError>

pub fn edit(&mut self, commit: &Commit) -> Result<(), EditCommitError>

pub fn format_commit_summary(&self, commit: &Commit) -> String

pub fn write_commit_summary( &self, formatter: &mut dyn Formatter, commit: &Commit, ) -> Result<()>

pub fn commit_summary_template(&self) -> TemplateRenderer<'_, Commit>

Template for one-line summary of a commit within transaction.

pub fn commit_template_language(&self) -> CommitTemplateLanguage<'_>

Creates commit template language environment capturing the current transaction state.

pub fn parse_commit_template( &self, ui: &Ui, template_text: &str, ) -> Result<TemplateRenderer<'_, Commit>, CommandError>

Parses commit template with the current transaction state.

pub fn finish( self, ui: &Ui, description: impl Into<String>, ) -> Result<(), CommandError>

pub fn into_inner(self) -> Transaction

Returns the wrapped Transaction for circumstances where finer-grained control is needed. The caller becomes responsible for finishing the Transaction, including rebasing descendants and updating the working copy, if applicable.

pub fn advance_bookmarks( &mut self, bookmarks: Vec<AdvanceableBookmark>, move_to: &CommitId, )

Moves each bookmark in bookmarks from an old commit it’s associated with (configured by get_advanceable_bookmarks) to the move_to commit. If the bookmark is conflicted before the update, it will remain conflicted after the update, but the conflict will involve the move_to commit instead of the old commit.