Struct git_repository::index::State
source · pub struct State { /* private fields */ }Expand description
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
sourceimpl State
impl State
General information and entries
sourcepub fn version(&self) -> Version
pub fn version(&self) -> Version
Return the version used to store this state’s information on disk.
sourcepub fn object_hash(&self) -> Kind
pub fn object_hash(&self) -> Kind
Return the kind of hashes used in this instance.
sourcepub fn path_backing(&self) -> &Vec<u8, Global> ⓘ
pub fn path_backing(&self) -> &Vec<u8, Global> ⓘ
Return our path backing, the place which keeps all paths one after another, with entries storing only the range to access them.
sourcepub fn take_path_backing(&mut self) -> Vec<u8, Global> ⓘ
pub fn take_path_backing(&mut self) -> Vec<u8, Global> ⓘ
Sometimes it’s needed to remove the path backing to allow certain mutation to happen in the state while supporting reading the entry’s path.
sourcepub fn return_path_backing(&mut self, backing: Vec<u8, Global>)
pub fn return_path_backing(&mut self, backing: Vec<u8, Global>)
After usage of the storage obtained by take_path_backing(), return it here.
Note that it must not be empty.
sourcepub 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_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
Runs filter_map on all entries, returning an iterator over all paths along with the result of filter_map.
sourcepub fn entries_mut(&mut self) -> &mut [Entry]
pub fn entries_mut(&mut self) -> &mut [Entry]
Return mutable entries in a slice.
sourcepub fn entries_mut_with_paths(
&mut self
) -> impl Iterator<Item = (&mut Entry, &BStr)>
pub fn entries_mut_with_paths(
&mut self
) -> impl Iterator<Item = (&mut Entry, &BStr)>
Return mutable entries along with their paths in an iterator.
sourcepub fn entries_mut_with_paths_in<'state, 'backing>(
&'state mut self,
backing: &'backing Vec<u8, Global>
) -> impl Iterator<Item = (&'state mut Entry, &'backing BStr)>
pub fn entries_mut_with_paths_in<'state, 'backing>(
&'state mut self,
backing: &'backing Vec<u8, Global>
) -> impl Iterator<Item = (&'state mut Entry, &'backing BStr)>
Return mutable entries along with their path, as obtained from backing.
sourcepub fn entry_index_by_path_and_stage(
&self,
path: &BStr,
stage: u32
) -> Option<usize>
pub fn entry_index_by_path_and_stage(
&self,
path: &BStr,
stage: u32
) -> Option<usize>
Find the entry index in entries() matching the given repository-relative
path and stage, or None.
Use the index for accessing multiple stages if they exists, but at least the single matching entry.
sourcepub fn entry_by_path_and_stage(&self, path: &BStr, stage: u32) -> Option<&Entry>
pub fn entry_by_path_and_stage(&self, path: &BStr, stage: u32) -> Option<&Entry>
Like entry_index_by_path_and_stage(),
but returns the entry instead of the index.
sourcepub fn entry(&self, idx: usize) -> &Entry
pub fn entry(&self, idx: usize) -> &Entry
Return the entry at idx or panic if the index is out of bounds.
The idx is typically returned by entry_by_path_and_stage().
sourceimpl State
impl State
Extensions
sourcepub fn resolve_undo(&self) -> Option<&Vec<ResolvePath, Global>>
pub fn resolve_undo(&self) -> Option<&Vec<ResolvePath, Global>>
Obtain the resolve-undo extension.
sourcepub fn untracked(&self) -> Option<&UntrackedCache>
pub fn untracked(&self) -> Option<&UntrackedCache>
Obtain the untracked extension.
sourcepub fn fs_monitor(&self) -> Option<&FsMonitor>
pub fn fs_monitor(&self) -> Option<&FsMonitor>
Obtain the fsmonitor extension.