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

path: PathBuf

checksum: ObjectId

The checksum of all bytes prior to the checksum itself.

Implementations

impl File

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

impl File

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

Methods from Deref<Target = State>

pub fn version(&self) -> Version

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

pub fn path_backing(&self) -> &Vec<u8, Global>

pub fn take_path_backing(&mut self) -> Vec<u8, Global>

pub fn return_path_backing(&mut self, backing: Vec<u8, Global>)

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 mut self,
    backing: &'backing Vec<u8, Global>
) -> 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, Global>>

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

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

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, 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.

Trait Implementations

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.