Struct GitStatsState 

pub struct GitStatsState { /* private fields */ }

Available on crate feature markdown-preview only.

Git stats state for markdown source files.

Tracks additions, modifications, and deletions from git diff.

Implementations

impl GitStatsState

Constructor for GitStatsState.

pub fn new() -> GitStatsState

Create a new git stats state with defaults.

impl GitStatsState

Git stats getter method for GitStatsState.

pub fn get(&self) -> Option<GitStats>

Get the cached git stats.

Returns

The cached GitStats if available and git stats are enabled.

pub fn git_stats(&self) -> Option<GitStats>

Get the cached git stats (alias for get()).

Returns

The cached GitStats if available and git stats are enabled.

pub fn is_enabled(&self) -> bool

Check if git stats display is enabled.

impl GitStatsState

Set show git stats method for GitStatsState.

pub fn set_show(&mut self, show: bool)

Enable or disable git stats display.

Arguments

• show - Whether to show git stats in the statusline.

impl GitStatsState

pub fn update(&mut self, source_path: Option<&Path>) -> bool

Update git stats if show is enabled and enough time has passed.

This method should be called periodically (e.g., in the render loop). It only computes stats every 2 seconds to avoid excessive git calls.

Arguments

• source_path - The path to the source file, if any.

Returns

true if stats were updated, false otherwise.

impl GitStatsState

pub fn update_if_changed( &mut self, source_path: Option<&Path>, watcher: &mut GitWatcher, ) -> bool

Update git stats using a GitWatcher for change detection.

This method only computes git stats when the watcher detects that the git repository state has changed, making it more efficient than time-based polling.

Arguments

• source_path - The path to the source file, if any.
• watcher - A mutable reference to the GitWatcher.

Returns

true if stats were updated, false otherwise.

Example

use ratatui_toolkit::markdown_widget::state::git_stats::GitStatsState;
use ratatui_toolkit::services::git_watcher::GitWatcher;
use std::path::Path;

let mut git_stats = GitStatsState::new();
git_stats.set_show(true);

let mut watcher = GitWatcher::new().unwrap();
watcher.watch(Path::new(".")).unwrap();

// In your event loop:
if git_stats.update_if_changed(Some(Path::new("README.md")), &mut watcher) {
    println!("Git stats updated!");
}

pub fn force_update(&mut self, source_path: Option<&Path>)

Force update git stats immediately.

This bypasses both time-based and watcher-based checks and immediately computes git stats.

Arguments

• source_path - The path to the source file, if any.

Trait Implementations

impl Clone for GitStatsState

fn clone(&self) -> GitStatsState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GitStatsState

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

Formats the value using the given formatter.

impl Default for GitStatsState

Default trait implementation for GitStatsState.

fn default() -> GitStatsState

Returns the “default value” for a type.