Skip to main content

Action

Enum Action 

Source
pub enum Action {
Show 45 variants Down, Up, Top, Bottom, ToggleSidebar, ToggleSidebarMode, CycleSidebarLayout, ToggleSidebarPosition, FocusSwap, FocusWorktrees, FocusStatus, Filter, Refresh, Sync, Create, DeleteConfirm, Bootstrap, ToggleDeleteBranch, Pull, Push, EditWorktree, ExitToWorktree, LazyGitPty, LazyGitFullscreen, ReviewFullscreen, ReviewPty, YankPath, YankBranchName, YankWorktreeName, TerminalPty, TerminalFullscreen, BrowseLinks, OpenDocs, LinkPrompt, FetchGithub, MuxPane, Macro1, Macro2, CommandLogs, ConfigPanel, ExecOverlay, CleanOverlay, Help, Quit, CommandPalette,
}
Expand description

Every user-rebindable verb the TUI exposes.

Variants whose semantics depend on the active view (Enter, Esc, Ctrl+C) are deliberately not listed — see the module-level “Hard-coded escape hatches” note for why.

Variants§

§

Down

§

Up

§

Top

§

Bottom

§

ToggleSidebar

§

ToggleSidebarMode

§

CycleSidebarLayout

§

ToggleSidebarPosition

§

FocusSwap

§

FocusWorktrees

§

FocusStatus

§

Filter

§

Refresh

§

Sync

§

Create

§

DeleteConfirm

§

Bootstrap

§

ToggleDeleteBranch

§

Pull

§

Push

§

EditWorktree

§

ExitToWorktree

§

LazyGitPty

§

LazyGitFullscreen

§

ReviewFullscreen

§

ReviewPty

§

YankPath

§

YankBranchName

§

YankWorktreeName

§

TerminalPty

§

TerminalFullscreen

§

OpenDocs

§

LinkPrompt

§

FetchGithub

§

MuxPane

§

Macro1

§

Macro2

§

CommandLogs

§

ConfigPanel

§

ExecOverlay

§

CleanOverlay

§

Help

§

Quit

§

CommandPalette

Implementations§

Source§

impl Action

Source

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

Stable string slug used in [tui.keys], gwm tui keys, and any future docs generator. Lowercase + underscores; never renamed in a backwards-incompatible way without a deprecation alias.

Source

pub fn from_slug(s: &str) -> Option<Self>

Inverse of Action::slug. Used by the config loader to translate .gwm.toml keys into typed actions.

Source

pub fn all() -> impl Iterator<Item = Self>

Iterator over every variant. Order matches the declarative macro invocation below, which is also the order surfaced by gwm tui keys.

Source§

impl Action

Source

pub fn from_slug_compat(s: &str) -> Option<Self>

Like Action::from_slug but also accepts the pre-#290 slugs that were renamed. Use this in config deserialization so existing .gwm.toml files with the old key names keep working after the upgrade.

The canonical slug is tried first; only on a miss do the compat aliases fire. The aliases are intentionally one-way: Action::slug() still returns the new canonical slug, so gwm tui keys and the help overlay stay up-to-date.

Source

pub fn is_repo_mutating(self) -> bool

Whether this action mutates a repo through the active repo context (App.repo/workdir/config) rather than only the selected worktree’s path. In workspace mode (#304) these are blocked while the selected row’s repo can’t be activated, since they would otherwise target the previously active repo. Navigation, yanks and read-only launchers are absent on purpose — they don’t write through the active repo handle.

Source

pub fn compat_alias_slugs(self) -> impl Iterator<Item = &'static str>

The pre-#290 alias slug(s) that resolve to this action, if any. Used by the in-TUI keymap editor (issue #294) to strip a stale alias from a legacy config when the canonical slug is (re)written — otherwise the alias, applied later in the sorted override walk, would silently shadow the new binding (Codex #297 review).

Trait Implementations§

Source§

impl Clone for Action

Source§

fn clone(&self) -> Action

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 Copy for Action

Source§

impl Debug for Action

Source§

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

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

impl Eq for Action

Source§

impl Hash for Action

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 Action

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · 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 StructuralPartialEq for Action

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> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.