Enum KeyAction 

pub enum KeyAction {
    NavigateUp,
    NavigateDown,
    PageUp,
    PageDown,
    GoToTop,
    GoToBottom,
    FocusNextPane,
    FocusPrevPane,
    Switch,
    Filter,
    ClearFilter,
    New,
    Remove,
    PrCheckout,
    Checkout,
    Sync,
    OpenEditor,
    Refresh,
    SortCycle,
    SortReverse,
    Help,
    Quit,
    ToggleSidebar,
    ResizeSidebarGrow,
    ResizeSidebarShrink,
}

A TUI action that can be bound to a key (spec §10/§11). The 24 variants match the action names accepted by ui.keybindings.

Variants

NavigateUp

Move the selection up.

NavigateDown

Move the selection down.

PageUp

Scroll up one page.

PageDown

Scroll down one page.

GoToTop

Jump to the first row.

GoToBottom

Jump to the last row.

FocusNextPane

Focus the next pane.

FocusPrevPane

Focus the previous pane.

Switch

Switch to the selected worktree (print path, exit).

Filter

Enter filter mode.

ClearFilter

Clear the filter / dismiss an overlay.

New

Open the create-worktree prompt.

Remove

Open the confirm-remove dialog.

PrCheckout

Open the PR picker.

Checkout

Check out a branch in the selected worktree (syncs with origin).

Sync

Sync (pull then push) the selected worktree’s branch.

OpenEditor

Open the selected worktree in the editor.

Refresh

Force a full async refresh.

SortCycle

Cycle the sort field.

SortReverse

Toggle the sort direction.

Help

Show the help overlay.

Quit

Quit without switching.

ToggleSidebar

Toggle the list pane (full-screen detail).

ResizeSidebarGrow

Grow the list pane width.

ResizeSidebarShrink

Shrink the list pane width.

Implementations

impl KeyAction

pub const ALL: [KeyAction; 25]

All actions, in the order documented in §11.

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

The action name used in ui.keybindings configuration.

pub fn parse(name: &str) -> Option<KeyAction>

Parses an action name, or None if unknown.

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

A short human label for the status bar and help overlay (e.g. switch, new, checkout). The match is exhaustive, so a new KeyAction variant cannot be added without giving it a label — this is what keeps the on-screen hints and help from drifting away from the key bindings (issue #39).

Trait Implementations

impl Clone for KeyAction

fn clone(&self) -> KeyAction

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for KeyAction

impl Debug for KeyAction

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

Formats the value using the given formatter.

impl Eq for KeyAction

impl Hash for KeyAction

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for KeyAction

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for KeyAction