Struct GitTuiState 

pub struct GitTuiState {

    pub doc: DiffDocument,
    pub entries: Vec<StatusEntry>,
    pub view: DiffViewMode,
    pub ws: WhitespaceMode,
    pub selected_file: usize,
    pub selected_hunk: usize,
    pub sidebar_focus: bool,
    pub staged: HashSet<String>,
    pub commit_mode: bool,
    pub commit_msg: String,
    pub needs_refresh: bool,
    pub width: u16,
    pub height: u16,
    pub branch: Option<String>,
    pub wrap: bool,
}

Interactive overlay state. One instance per open /git session.

entries are kept in the order produced by git status --porcelain -z — the sidebar renders them as-is. staged mirrors the porcelain index column: paths whose xy[0] is neither ' ' (unstaged) nor '?' (untracked) are staged. It is re-derived on every GitTuiState::load and GitTuiState::refresh, so files staged outside the overlay (plain git add in another terminal) are operable too.

needs_refresh is available for callers that batch mutations and want to force a refresh on the next frame; it is consumed (cleared) by GitTuiState::refresh. The built-in mutators (GitTuiState::toggle_stage, GitTuiState::commit) refresh inline after their git command succeeds, so the overlay reflects the new state on the very next frame without it.

Fields

doc: DiffDocument

entries: Vec<StatusEntry>

view: DiffViewMode

ws: WhitespaceMode

selected_file: usize

selected_hunk: usize

sidebar_focus: bool

staged: HashSet<String>

commit_mode: bool

commit_msg: String

needs_refresh: bool

width: u16

height: u16

branch: Option<String>

Cached git branch --show-current captured at GitTuiState::load. Refreshed by GitTuiState::refresh.

wrap: bool

Soft-wrap toggle for the diff pane (the brief’s w binding).

Implementations

impl GitTuiState

pub fn load(cwd: &Path) -> Result<Self>

Load status + diff for cwd. Builds the entry list from git status --porcelain -z and the diff document from git diff HEAD --no-ext-diff. Untracked entries (XY[0]=='?') get a placeholder DiffFile with no hunks so selection still works.

pub fn refresh(&mut self, cwd: &Path) -> Result<()>

Re-run git status + git diff HEAD and rebuild the document. Preserves the current selection where possible (clamped to the new entry count).

pub fn toggle_stage(&mut self, cwd: &Path, path: &str) -> Result<()>

Toggle staging for path. Staged entries leave the unstaged list (status output will show them with X != space); unstaged entries reappear in the unstaged list. Refreshes inline on success so entries / doc / staged reflect the git state immediately (final-review finding 3 — the overlay used to keep showing the pre-mutation diff until a manual r).

pub fn commit(&mut self, cwd: &Path) -> Result<()>

Commit with the current commit_msg. Clears the message on success and refreshes inline so the committed change leaves the diff view on the next frame. Empty messages are rejected (git commit -m "" would otherwise open an editor and hang the overlay).

pub fn apply_action(&mut self, cwd: &Path, action: GitKeyAction) -> Result<bool>

Apply a GitKeyAction (or raw char for commit-mode text input). Returns true if the action was consumed.

pub fn commit_input_char(&mut self, ch: char)

Append one char to the commit message (commit-mode text input).

pub fn commit_backspace(&mut self)

Backspace one char from the commit message (commit-mode).

Trait Implementations

impl Clone for GitTuiState

fn clone(&self) -> GitTuiState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GitTuiState

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

Formats the value using the given formatter.