Skip to content

command

Enums


firma_tui::control::command::ControlCommand

Section titled “firma_tui::control::command::ControlCommand”

Enum

User command after key bindings have been resolved.

Commands mutate [App] state and may return runner-owned side effects. Keeping key parsing separate from command application lets the help text and event loop use the same command vocabulary.

Variants:

  • ToggleHelp - Toggle the help overlay.
  • CloseHelp - Close the help overlay.
  • SetAuditFilter(crate::control::state::AuditFilter) - Change the audit decision filter.
  • MoveSelection(SelectionMovement) - Move selection in the focused pane.
  • SwitchPane - Move focus to the next pane.
  • Quit - Request shutdown.

Methods:

  • fn apply(self: Self, app: & mut App) -> Vec<ControlEffect> - Applies the command to app state and returns runner-owned effects.

Traits: Eq, Copy

Trait Implementations:

  • Clone
    • fn clone(self: &Self) -> ControlCommand
  • PartialEq
    • fn eq(self: &Self, other: &ControlCommand) -> bool
  • Debug
    • fn fmt(self: &Self, f: & mut $crate::fmt::Formatter) -> $crate::fmt::Result

firma_tui::control::command::ControlEffect

Section titled “firma_tui::control::command::ControlEffect”

Enum

Side effect produced by a command.

Effects are executed by the runner after command application. This keeps application state free of terminal and process ownership.

Variants:

  • Announce(crate::control::announcement::ControlAnnouncement) - Runtime announcement to handle at the event-loop boundary.

Traits: Eq, Copy

Trait Implementations:

  • Clone
    • fn clone(self: &Self) -> ControlEffect
  • PartialEq
    • fn eq(self: &Self, other: &ControlEffect) -> bool
  • Debug
    • fn fmt(self: &Self, f: & mut $crate::fmt::Formatter) -> $crate::fmt::Result

firma_tui::control::command::SelectionMovement

Section titled “firma_tui::control::command::SelectionMovement”

Enum

Selection movement requested by keyboard input.

Variants:

  • Up - Move one row toward the start of the focused pane.
  • Down - Move one row toward the end of the focused pane.
  • First - Jump to the first row in the focused pane.
  • Last - Jump to the last row in the focused pane.

Traits: Copy, Eq

Trait Implementations:

  • Debug
    • fn fmt(self: &Self, f: & mut $crate::fmt::Formatter) -> $crate::fmt::Result
  • Clone
    • fn clone(self: &Self) -> SelectionMovement
  • PartialEq
    • fn eq(self: &Self, other: &SelectionMovement) -> bool