Enum RebaseCommand

pub enum RebaseCommand {
    CreateLabel {
        label_name: String,
    },
    Reset {
        target: OidOrLabel,
    },
    Pick {
        original_commit_oid: NonZeroOid,
        commits_to_apply_oids: Vec<NonZeroOid>,
    },
    Merge {
        commit_oid: NonZeroOid,
        commits_to_merge: Vec<OidOrLabel>,
    },
    Replace {
        commit_oid: NonZeroOid,
        replacement_commit_oid: NonZeroOid,
        parents: Vec<OidOrLabel>,
    },
    Break,
    RegisterExtraPostRewriteHook,
    DetectEmptyCommit {
        commit_oid: NonZeroOid,
    },
    SkipUpstreamAppliedCommit {
        commit_oid: NonZeroOid,
    },
}

A command that can be applied for either in-memory or on-disk rebases.

Variants

CreateLabel

Create a label (a reference stored in refs/rewritten/) pointing to the current rebase head for later use.

Fields

label_name: String

The new label name.

Reset

Move the rebase head to the provided label or commit.

Fields

target: OidOrLabel

The target to check out.

Pick

Apply the provided commits on top of the rebase head, and update the rebase head to point to the newly-applied commit.

If multiple commits are provided, they will be squashed into a single commit.

Fields

original_commit_oid: NonZeroOid

The original commit, which contains the relevant metadata such as the commit message.

commits_to_apply_oids: Vec<NonZeroOid>

The commits whose patches should be applied to the rebase head.

• This will be different from original_commit_oid when a commit is being replaced.
• If this is a single commit, then the rebase will perform a normal pick.
• If this is multiple commits, they will all be squashed into a single commit, reusing the metadata (message, author, timestamps, etc) from original_commit_oid.

Merge

Merge two or more parent commits.

Fields

commit_oid: NonZeroOid

The original merge commit to copy the commit contents from.

commits_to_merge: Vec<OidOrLabel>

The other commits to merge into this one. This may be a list of either OIDs or strings. This will always be one fewer commit than the number of actual parents for this commit, since we always merge into the current HEAD commit when rebasing.

Replace

When rebasing commit_oid, apply it by replacing its commit metadata and tree with that of replacement_commit_oid, and by replacing its parents with parents. No patches will be computed or applied, so this operation is guaranteed to never cause a merge conflict.

Fields

commit_oid: NonZeroOid

The commit to be replaced. It should be part of another rebase command, or else we will never encounter it for replacement.

replacement_commit_oid: NonZeroOid

The replacement commit whose metadata and tree we’ll use.

parents: Vec<OidOrLabel>

The new parents for the replaced commit.

Break

Pause the rebase, to be resumed later. Only supported in on-disk rebases.

RegisterExtraPostRewriteHook

On-disk rebases only. Register that we want to run cleanup at the end of the rebase, during the post-rewrite hook.

DetectEmptyCommit

Determine if the current commit is empty. If so, reset the rebase head to its parent and record that it was empty in the rewritten-list.

Fields

commit_oid: NonZeroOid

The original commit. If the new commit is empty, then the original commit will be recorded as skipped.

SkipUpstreamAppliedCommit

The commit that would have been applied to the rebase head was already applied upstream. Skip it and record it in the rewritten-list.

Fields

commit_oid: NonZeroOid

The original commit, which will be recorded as skipped.

Implementations

impl RebaseCommand

pub fn to_rebase_command(&self) -> String

Convert the command to a string that’s used in the git rebase plan format.

Trait Implementations

impl Debug for RebaseCommand

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

Formats the value using the given formatter.