Skip to main content

CommitActionKind

Enum CommitActionKind 

Source
pub enum CommitActionKind {
    CheckoutDetached,
    CreateBranchHere,
    CherryPick,
    Revert,
    RebaseOnto,
    ResetSoft,
    ResetMixed,
    ResetHard,
    CreateTag,
    CreateAnnotatedTag,
}
Expand description

Discriminant-only commit action — used for building menus before input values are known. Every variant maps 1-to-1 to a CommitAction variant.

Variants§

§

CheckoutDetached

§

CreateBranchHere

§

CherryPick

§

Revert

§

RebaseOnto

§

ResetSoft

§

ResetMixed

§

ResetHard

§

CreateTag

§

CreateAnnotatedTag

Implementations§

Source§

impl CommitActionKind

Source

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

Human-readable label shown in menus and key-hint panels.

Source

pub fn input_prompt(self) -> Option<&'static str>

Prompt to show when this action needs a first user-supplied string (e.g. branch name, tag name). None for actions that need no input.

Source

pub fn second_input_prompt(self) -> Option<&'static str>

Prompt to show when this action needs a second string (e.g. annotated-tag message). None for most actions.

Source

pub fn needs_input(self) -> bool

Whether this action requires at least one string from the user before it can execute.

Source

pub fn needs_second_input(self) -> bool

Whether this action requires a second string.

Source

pub fn into_action(self, input1: String, input2: String) -> CommitAction

Build the corresponding CommitAction from this kind plus up to two collected input strings. Pass empty strings for inputs that are not used by this variant.

Source

pub fn as_simple_action(self) -> Option<CommitAction>

Convenience: build a CommitAction for variants that need no user input. Returns None for input-needing variants.

Trait Implementations§

Source§

impl Clone for CommitActionKind

Source§

fn clone(&self) -> CommitActionKind

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for CommitActionKind

Source§

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

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

impl Hash for CommitActionKind

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for CommitActionKind

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Copy for CommitActionKind

Source§

impl Eq for CommitActionKind

Source§

impl StructuralPartialEq for CommitActionKind

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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more