Crate gix_worktree

A crate with all index-centric functionality that is interacting with a worktree.

Unless specified differently, all operations need an index file (e.g. .git/index) as driver.

Feature Flags

• serde — Data structures implement serde::Serialize and serde::Deserialize.

Modules

• cache
• checkout
• read
  This module allows creating git blobs from worktree files.
• status
  Changes between an index and a worktree.

Structs

• Cache
  A cache for efficiently executing operations on directories and files which are encountered in sorted order. That way, these operations can be re-used for subsequent invocations in the same directory.

Functions

• checkout
  Checkout the entire index into dir, and resolve objects found in index entries with find to write their content to their respective path in dir. Use files to count each fully checked out file, and count the amount written bytes. If should_interrupt is true, the operation will abort. options provide a lot of context on how to perform the operation.
• status
  Calculates the changes that need to be applied to an index to match the state of the worktree and makes them observable in collector, along with information produced by compare which gets to see blobs that may have changes. options are used to configure the operation.