Struct git_index::State

pub struct State { /* private fields */ }

An in-memory cache of a fully parsed git index file.

As opposed to a snapshot, it’s meant to be altered and eventually be written back to disk or converted into a tree. We treat index and its state synonymous.

Implementations

impl State

pub fn version(&self) -> Version

pub fn entries(&self) -> &[Entry]

pub fn path_backing(&self) -> &PathStorage

pub fn take_path_backing(&mut self) -> PathStorage

pub fn return_path_backing(&mut self, backing: PathStorage)

pub fn entries_with_paths_by_filter_map<'a, T>(
    &'a self,
    filter_map: impl FnMut(&'a BStr, &Entry) -> Option<T> + 'a
) -> impl Iterator<Item = (&'a BStr, T)> + 'a

pub fn entries_mut(&mut self) -> &mut [Entry]

pub fn entries_mut_with_paths(
    &mut self
) -> impl Iterator<Item = (&mut Entry, &BStr)>

pub fn entries_mut_with_paths_in<'state, 'backing>(
    &'state mut self,
    backing: &'backing PathStorage
) -> impl Iterator<Item = (&'state mut Entry, &'backing BStr)>

pub fn tree(&self) -> Option<&Tree>

pub fn link(&self) -> Option<&Link>

pub fn resolve_undo(&self) -> Option<&Vec<ResolvePath>>

pub fn untracked(&self) -> Option<&UntrackedCache>

pub fn fs_monitor(&self) -> Option<&FsMonitor>

impl State

pub fn from_bytes(
    data: &[u8],
    timestamp: FileTime,
    _: Options
) -> Result<(Self, ObjectId), Error>

impl State

pub fn verify_entries(&self) -> Result<(), Error>

pub fn verify_extensions<F>(&self, use_find: bool, find: F) -> Result<(), Error> where
    F: for<'a> FnMut(&oid, &'a mut Vec<u8>) -> Option<TreeRefIter<'a>>, 

Note: find cannot be Option<F> as we can’t call it with a closure then due to the indirection through Some.