Struct git_repository::index::File

pub struct File {
    pub state: State,
    pub path: PathBuf,
    pub checksum: ObjectId,
}

An index file whose state was read from a file on disk.

Fields

state: State

The state containing the actual index data.

path: PathBuf

The path from which the index was read or to which it is supposed to be written.

checksum: ObjectId

The checksum of all bytes prior to the checksum itself.

Implementations

impl File

Initialization

pub fn at(path: impl Into<PathBuf>, options: Options) -> Result<File, Error>

Open an index file at path with options.

impl File

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

Verify the integrity of the index to assure its consistency.

impl File

pub fn write_to(
    &self,
    out: impl Write,
    options: Options
) -> Result<Version, Error>

Write the index to out with options, to be readable by File::at(), returning the version that was actually written to retain all information of this index.

Methods from Deref<Target = State>

pub fn version(&self) -> Version

Return the version used to store this state’s information on disk.

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

Return our entries

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.

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.

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.

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.

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

Return mutable entries in a slice.

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

Return mutable entries along with their paths in an iterator.

pub fn entries_mut_with_paths_in(
    &'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.

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.

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.

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().

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

Access the tree extension.

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

Access the link extension.

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

Obtain the resolve-undo extension.

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

Obtain the untracked extension.

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

Obtain the fsmonitor extension.

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

Assure our entries are consistent.

pub fn verify_extensions<F>(&self, use_find: bool, find: F) -> Result<(), Error> where
    F: for<'a> FnMut(&oid, &'a mut Vec<u8, Global>) -> 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.

pub fn write_to(&self, out: impl Write, Options) -> Result<Version, Error>

Serialize this instance to out with options.

Trait Implementations

impl Debug for File

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

Formats the value using the given formatter.

impl Deref for File

type Target = State

The resulting type after dereferencing.

fn deref(&self) -> &<File as Deref>::Target

Dereferences the value.

impl DerefMut for File

fn deref_mut(&mut self) -> &mut <File as Deref>::Target

Mutably dereferences the value.