Skip to main content

NextAction

Enum NextAction 

Source
pub enum NextAction {
Show 13 variants StartNewWork, SyncHomeWithUpstream { behind_count: usize, }, CommitChanges, PushChanges, CreatePr { base: Option<String>, }, WaitingForReview { pr_number: u64, }, Cleanup, BehindBase { base: String, behind_count: usize, }, PullUpstream { behind_count: usize, }, ResolveDivergence, PrClosed { pr_number: u64, }, SyncNeeded { base_branch: String, }, StackedBaseMerged { base_branch: String, base_sha: Option<String>, },
}
Expand description

Recommended next action based on current state

Variants§

§

StartNewWork

On home branch, ready to start new work

§

SyncHomeWithUpstream

On home branch but behind upstream, should sync first

Fields

§behind_count: usize
§

CommitChanges

Has uncommitted changes, should commit

§

PushChanges

Has unpushed commits, should push

§

CreatePr

Pushed but no PR, should create PR. base is the stacked parent branch to pass as -B, or None when the PR targets the default branch.

Fields

§

WaitingForReview

PR is open, waiting for review/CI

Fields

§pr_number: u64
§

Cleanup

PR is merged, should cleanup

§

BehindBase

The base this branch sits on (origin/main, or the stacked parent) has new commits; catch up with gw sync before publishing.

Fields

§base: String
§behind_count: usize
§

PullUpstream

Someone pushed to this branch’s upstream; pull those commits first.

Fields

§behind_count: usize
§

ResolveDivergence

Branch has diverged from upstream, needs resolution

§

PrClosed

PR was closed without merging

Fields

§pr_number: u64
§

SyncNeeded

Base PR was merged, should sync (update base to main, rebase, push)

Fields

§base_branch: String
§

StackedBaseMerged

Recorded stacked base merged before this branch’s PR was created; rebase onto the default branch and open a normal (non-stacked) PR. base_sha is the recorded base tip used as the --onto boundary when present (it survives the base branch being deleted).

Fields

§base_branch: String
§base_sha: Option<String>

Implementations§

Source§

impl NextAction

Source

pub fn detect(ctx: &DetectContext<'_>) -> Self

Detect the next action based on current state. See DetectContext.

Source

pub fn display(&self, branch: &str)

Display the next action with commands

Source

pub fn short_description(&self) -> &'static str

Get a short description for the action

Trait Implementations§

Source§

impl Clone for NextAction

Source§

fn clone(&self) -> NextAction

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for NextAction

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for NextAction

Source§

impl PartialEq for NextAction

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for NextAction

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.