Struct GitStatusModule 

pub struct GitStatusModule;

Module that summarizes Git working tree and index state

Displays indicators for:

• Modified files (working tree changes)
• Staged files (index changes)
• Untracked files
• Branch ahead/behind status relative to upstream
• Conflicted files during merge

Configuration

[git_status]
format = "[$all_status$ahead_behind]($style)"
style = "bold red"
conflicted = "="
ahead = "⇡"
behind = "⇣"
diverged = "⇕"
untracked = "?"
stashed = "$"
modified = "!"
staged = "+"
renamed = "»"
deleted = "✘"
disabled = false

Display Format

Shows compact symbols for repository state, e.g.:

• [!] - Has modified files
• [+] - Has staged changes
• [⇡3] - Ahead by 3 commits
• [⇣2] - Behind by 2 commits

Implementations

impl GitStatusModule

pub fn new() -> Self

pub fn from_context(_context: &Context) -> Self

Trait Implementations

impl Default for GitStatusModule

fn default() -> Self

Returns the “default value” for a type.

impl Module for GitStatusModule

fn name(&self) -> &str

Returns the name of the module

fn should_display(&self, context: &Context, config: &dyn ModuleConfig) -> bool

Determines if this module should be displayed

fn render(&self, context: &Context, config: &dyn ModuleConfig) -> String

Renders the module’s output as a string