Struct WorkspaceIndex 

pub struct WorkspaceIndex {
    pub version: u32,
    pub commit_cid: Option<CommitCid>,
    pub entries: Vec<IndexEntry>,
}

Workspace index snapshot.

Fields

version: u32

commit_cid: Option<CommitCid>

entries: Vec<IndexEntry>

Implementations

impl WorkspaceIndex

pub const VERSION: u32 = 1

pub fn new(commit_cid: Option<CommitCid>, entries: Vec<IndexEntry>) -> Self

pub fn empty() -> Self

Create an empty index with no entries.

pub fn stage_file(&mut self, base: &Utf8Path, rel_path: &str) -> Result<()>

Stage a file (add to index from worktree).

Reads the file from disk, computes its hash and metadata, and adds/updates the entry in the index.

Arguments

• base - The workspace root directory
• rel_path - The relative path of the file to stage

Errors

Returns an error if the file cannot be read.

pub fn upsert_entry(&mut self, entry: IndexEntry)

Insert or replace a precomputed entry.

pub fn unstage_file( &mut self, rel_path: &str, head_entry: Option<&IndexEntry>, ) -> Result<()>

Unstage a file (reset to HEAD state or remove if new).

If head_entry is Some, replaces the current entry with the HEAD version. If head_entry is None, removes the entry from the index entirely.

Arguments

• rel_path - The relative path of the file to unstage
• head_entry - The entry from HEAD commit, or None if the file is new

pub fn get(&self, path: &str) -> Option<&IndexEntry>

Get entry by path.

pub fn has_staged_changes(&self, head_entries: &[IndexEntry]) -> bool

Check if index has uncommitted changes vs HEAD.

Returns true if:

• Any entry in the index differs from HEAD (by path or content_hash)
• Any entry exists in HEAD but not in the index
• Any entry exists in the index but not in HEAD

pub fn iter(&self) -> impl Iterator<Item = &IndexEntry>

Iterate over all entries.

pub fn len(&self) -> usize

Get the number of entries in the index.

pub fn is_empty(&self) -> bool

Check if the index is empty.

Trait Implementations

impl Clone for WorkspaceIndex

fn clone(&self) -> WorkspaceIndex

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WorkspaceIndex

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for WorkspaceIndex

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for WorkspaceIndex

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.