Crate git_status_vars

This is primarily a command line utility. The documentation for the command line interface is in README.md.

The primary entrance to this code is summarize_repository(). It opens a Repository, then calls summarize_opened_repository() on it.

Currently the minimum supported Rust version (MSRV) is 1.64.

Versioning

This follows semantic versioning for the command line utility, not the crate API. Breaking changes to the API are not guaranteed to involve a major version change, since I don’t anticipate this being used as a crate by anyone else.

Structs

• ChangeCounters
  Track changes in the working tree and index (staged area).
• Head
  The trail of a HEAD reference.
• Reference
  A reference in a git repository.
• ShellWriter
  A writer of var=value pairs.

Traits

• ShellVars
  An object that can be written as a group of shell variables.

Functions

• count_changes
  Count changes in the working tree and index (staged area) of a repository.
• get_upstream_difference
  Get the (ahead, behind) count of HEAD versus its upstream branch.
• head_info
  Trace the HEAD reference for a repository.
• shell_quote
  Quote a value for safe shell insertion.
• shell_quote_debug
  Format a value with Debug and quote it for safe shell insertion.
• summarize_opened_repository
  Summarize information about a successfully opened repository.
• summarize_repository
  Summarize information about a repository.