Enum CommitIntent 

pub enum CommitIntent {
    Create,
    Amend,
    Reword,
    Augment {
        target: String,
    },
    MergeEdit {
        branch: String,
    },
    RewordCommit {
        target: String,
    },
}

MG.42-E1: what the compose buffer is FOR.

Replaces an amend: bool that was derived by sniffing the buffer name. A bool cannot express a third intent, and the sniff coupled a buffer’s name to its behaviour — rename the buffer and the operation silently changes. The name still selects the intent, but it does so once, explicitly, at open.

Variants

Create

A new commit from what is staged.

Amend

Replace the last commit, sweeping in anything staged.

Reword

Replace the last commit’s MESSAGE only, leaving the index alone. Distinct from Amend precisely because a reword that quietly absorbed staged changes would be a content change the user never asked for.

Augment

Record a squash! marker for target, carrying the note the user writes in the buffer. Magit’s A.

Fields

target: String

MergeEdit

Complete a merge of branch with an authored message. Magit’s merge e.

Fields

branch: String

RewordCommit

MG.43c: reword a commit that is NOT HEAD, via an interactive rebase. Magit’s rebase w.

Distinct from Self::Reword, which amends HEAD directly. A commit further back cannot be amended, so this replays history with that commit’s todo verb set to reword and hands git the message through GIT_EDITOR.

Fields

target: String

Implementations

impl CommitIntent

pub fn from_buffer_name(name: &str) -> Self

Map a compose buffer’s name to its intent. Kept in ONE place so the mapping is auditable.

MR.3: read through the shared name grammar (*magit:<view>[:<repo>[:<rest>]]*) rather than by substring.

The substring form it replaces (name.contains("reword")) was fine while names held only a view word; with a repository in the name, a checkout called amend or reword would have selected the wrong operation on every commit buffer in it. Structured parsing makes that unrepresentable rather than unlikely.

A name that does not parse at all falls to Create, which is what an unrecognised compose buffer did before.

pub fn augment_buffer_name(repo: &str, target: &str) -> String

The buffer name that selects this intent, for the repository labelled repo (empty outside one).

pub fn merge_edit_buffer_name(repo: &str, branch: &str) -> String

pub fn reword_commit_buffer_name(repo: &str, target: &str) -> String

pub fn seeds_prior_message(&self) -> bool

Does the buffer open pre-filled with the previous message?

pub fn seed_source(&self) -> Option<&str>

The commit whose message seeds the buffer, when it is not HEAD.

Trait Implementations

impl Clone for CommitIntent

fn clone(&self) -> CommitIntent

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CommitIntent

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

Formats the value using the given formatter.

impl Eq for CommitIntent

impl PartialEq for CommitIntent

fn eq(&self, other: &CommitIntent) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for CommitIntent