Struct Index 

pub struct Index {
    pub entries: Vec<IndexEntry>,
}

In-memory staging index.

Fields

entries: Vec<IndexEntry>

Entries in insertion order.

Implementations

impl Index

pub const fn new() -> Self

Construct an empty index.

pub fn find_entry(&self, path: &str) -> Option<usize>

Find an entry by path. O(n).

pub fn tracks_path_or_descendant(&self, path: &str) -> bool

true if path is itself tracked (a non-removed entry) or is an ancestor directory of a tracked path. Used to decide whether an ignored worktree path must still be visited because it (or its subtree) holds tracked content. O(n).

pub fn has_tracked_file_at(&self, path: &str) -> bool

true if a tracked (non-removed) entry exists at exactly path.

Because the index stores only leaf paths (files / symlinks / exec files, never directories), a hit means path is tracked as a non-directory object. Used by the untracked-discovery walks to detect a worktree directory that shadows a tracked file: git suppresses the directory’s contents as untracked in that case (#288), reporting only the tracked-side deletion. A Removed tombstone does not count — the path is no longer tracked, so its replacement is genuinely untracked. O(n).

pub fn staged_count(&self) -> usize

Count non-removed entries.

pub fn serialize(&self) -> Vec<u8>

Serialise to the on-disk byte form per SPEC-INDEX §2.

Panics

Panics if any entry’s path exceeds u16::MAX bytes; callers should reject such paths via validate_index_path earlier.

Trait Implementations

impl Clone for Index

fn clone(&self) -> Index

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Index

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

Formats the value using the given formatter.

impl Default for Index

fn default() -> Index

Returns the “default value” for a type.

impl Eq for Index

impl PartialEq for Index

fn eq(&self, other: &Index) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Index