Struct Index 

pub struct Index { /* private fields */ }

see index-format
to Working Dir relative path

Implementations

impl Index

pub fn new() -> Self

pub fn size(&self) -> usize

pub fn from_file(path: impl AsRef<Path>) -> Result<Self, GitError>

pub fn to_file(&self, path: impl AsRef<Path>) -> Result<(), GitError>

pub fn refresh( &mut self, file: impl AsRef<Path>, workdir: &Path, ) -> Result<bool, GitError>

impl Index

pub fn load(index_file: impl AsRef<Path>) -> Result<Self, GitError>

Load index. If it does not exist, return an empty index.

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

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

pub fn remove(&mut self, name: &str, stage: u8) -> Option<IndexEntry>

pub fn get(&self, name: &str, stage: u8) -> Option<&IndexEntry>

pub fn tracked(&self, name: &str, stage: u8) -> bool

pub fn get_hash(&self, file: &str, stage: u8) -> Option<SHA1>

pub fn verify_hash(&self, file: &str, stage: u8, hash: &SHA1) -> bool

pub fn is_modified(&self, file: &str, stage: u8, workdir: &Path) -> bool

is file modified after last add (need hash to confirm content change)

• workdir is used to rebuild absolute file path

pub fn tracked_entries(&self, stage: u8) -> Vec<&IndexEntry>

Get all entries with the same stage

pub fn tracked_files(&self) -> Vec<PathBuf>

Get all tracked files(stage = 0)

pub fn contains_dir_file(&self, dir: &str) -> bool

Judge if the file(s) of dir is in the index

• false if dir is a file

pub fn remove_dir_files(&mut self, dir: &str) -> Vec<String>

remove all files in dir from index

• do nothing if dir is a file

pub fn save(&self, index_file: impl AsRef<Path>) -> Result<(), GitError>

saved to index file

Trait Implementations

impl Default for Index

fn default() -> Self

Returns the “default value” for a type.