gix-index 0.56.0

A work-in-progress crate of the gitoxide project dedicated implementing the git index file
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42

use std::cmp::Ordering;

use gix_error::ExnMessageResult;

use crate::State;

impl State {
    /// Assure our entries are consistent.
    pub fn verify_entries(&self) -> ExnMessageResult {
        use gix_error::ErrorExt;

        let _span = gix_features::trace::coarse!("gix_index::File::verify_entries()");
        let mut previous = None::<&crate::Entry>;
        for (idx, entry) in self.entries.iter().enumerate() {
            if let Some(prev) = previous
                && prev.cmp(entry, self) != Ordering::Less
            {
                return Err(gix_error::corruption(format!(
                    "Entry '{}' (stage = {}) at index {idx} should order after prior entry '{}' (stage = {})",
                    entry.path(self),
                    entry.flags.stage() as u8,
                    prev.path(self),
                    prev.flags.stage() as u8
                ))
                .raise());
            }
            previous = Some(entry);
        }
        Ok(())
    }

    /// Note: `objects` cannot be `Option<F>` as we can't call it with a closure then due to the indirection through `Some`.
    pub fn verify_extensions(&self, use_find: bool, objects: impl gix_object::Find) -> ExnMessageResult {
        if let Some(tree) = self.tree() {
            tree.verify(use_find, objects)?;
            tree.verify_entries_count(self.entries.len())?;
        }
        // TODO: verify links by running the whole set of tests on the index
        //       - do that once we load it as well, or maybe that's lazy loaded? Too many questions for now.
        Ok(())
    }
}