Module gix::worktree

Modules

• attributes
• cache
• checkout
• excludes
• open_index
• proxy
• 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.
• Proxy
  A stand-in to a worktree as result of a worktree iteration.

Functions

• checkout
  Note that interruption still produce an Ok(…) value, so the caller should look at should_interrupt to communicate the outcome. dir is the directory into which to checkout the index. git_dir is the .git directory for reading additional per-repository configuration files.
• 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.

Type Definitions

• Index
  A lazily loaded and auto-updated worktree index.