#git #status #index

gix-status

A crate of the gitoxide project dealing with 'git status'-like functionality

18 breaking releases

0.19.1 Apr 26, 2025
0.18.0 Apr 4, 2025
0.17.0 Jan 18, 2025
0.16.0 Dec 22, 2024
0.2.0 Oct 12, 2023

#1877 in Development tools

Download history 6174/week @ 2025-01-31 8819/week @ 2025-02-07 11117/week @ 2025-02-14 10449/week @ 2025-02-21 21521/week @ 2025-02-28 20246/week @ 2025-03-07 15431/week @ 2025-03-14 11457/week @ 2025-03-21 114458/week @ 2025-03-28 247019/week @ 2025-04-04 164451/week @ 2025-04-11 64198/week @ 2025-04-18 59584/week @ 2025-04-25 97793/week @ 2025-05-02 101256/week @ 2025-05-09 76845/week @ 2025-05-16

347,521 downloads per month
Used in 58 crates (2 directly)

MIT/Apache

1MB
18K SLoC

This crate includes the various diffs git can do between different representations of the repository state, like comparisons between…

  • index and working tree
  • tree and index

…while also being able to check if the working tree is dirty, quickly, by instructing the operation to stop once the first change was found.

Tree-Index Status

This status is not actually implemented here as it's not implemented directly. Instead, one creates an Index from a tree and then diffs two indices with gix_diff::index(index_from_tree, usually_dot_git_index). This adds about 15% to the runtime and comes at the cost of another index in memory. Once there are generators implementing depth-first tree iteration should become trivial, but for now it's very hard if one wants to return referenced state of the iterator (which is not possible).

Difference to gix-diff

Technically, status is just another form of diff between different kind of sides, i.e. an index and a working tree. This is the difference to gix-diff, which compares only similar items.

Feature Flags

Dependencies

~16–28MB
~485K SLoC