git-odb 0.7.1

Implements a git object database for loose objects and packs
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
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94

use crate::loose;

/// An object within an object database with loose or entirely borrowed objects.
#[derive(PartialEq, Eq, Debug, Hash, Ord, PartialOrd, Clone)]
#[allow(missing_docs)]
pub enum Object<'a> {
    Loose(loose::Object),
    Borrowed(crate::borrowed::Object<'a>),
}

/// Access
impl<'a> Object<'a> {
    /// Returns the object [`kind`][`git_object::Kind`].
    pub fn kind(&self) -> git_object::Kind {
        match self {
            Object::Borrowed(object) => object.kind,
            Object::Loose(object) => object.kind,
        }
    }

    /// Returns the uncompressed size of the uncompressed object data in bytes.
    pub fn size(&self) -> usize {
        match self {
            Object::Borrowed(object) => object.data.len(),
            Object::Loose(object) => object.size,
        }
    }
}

///
pub mod decode {
    use crate::{compound::Object, loose};

    /// Returned by [`Object::decode()`].
    #[derive(thiserror::Error, Debug)]
    #[allow(missing_docs)]
    pub enum Error {
        #[error(transparent)]
        Decode(#[from] git_object::borrowed::Error),
        #[error(transparent)]
        LooseObject(#[from] loose::object::decode::Error),
    }

    impl<'a> Object<'a> {
        /// Decode an object for accessing individual fields.
        /// _Note_ that this is inefficient for big loose blobs, which should rather be streamed.
        pub fn decode(&mut self) -> Result<git_object::borrowed::Object<'_>, Error> {
            match self {
                Object::Borrowed(object) => object.decode().map_err(Into::into),
                Object::Loose(object) => object.decode().map_err(Into::into),
            }
        }
    }
}

///
pub mod verify {
    use crate::{compound::Object, loose};
    use git_object::borrowed;

    /// Returned by [`Object::verify_checksum()`].
    #[derive(thiserror::Error, Debug)]
    #[allow(missing_docs)]
    pub enum Error {
        #[error(transparent)]
        Pack(#[from] crate::borrowed::verify::Error),
        #[error(transparent)]
        Loose(#[from] loose::object::verify::Error),
    }

    impl<'a> Object<'a> {
        /// Assert whether the actual checksum of this object matches the `desired` one.
        pub fn verify_checksum(&mut self, desired: borrowed::Id<'_>) -> Result<(), Error> {
            match self {
                Object::Borrowed(object) => object.verify_checksum(desired).map_err(Into::into),
                Object::Loose(object) => object.verify_checksum(desired).map_err(Into::into),
            }
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn size_in_memory() {
        assert_eq!(
            std::mem::size_of::<Object<'_>>(),
            856,
            "the object size should not grow unexpectedly"
        );
    }
}