git_pack/cache/
mod.rs

1use std::ops::DerefMut;
2
3use git_object::Kind;
4
5/// A trait to model putting objects at a given pack `offset` into a cache, and fetching them.
6///
7/// It is used to speed up [pack traversals][crate::index::File::traverse()].
8pub trait DecodeEntry {
9    /// Store a fully decoded object at `offset` of `kind` with `compressed_size` and `data` in the cache.
10    ///
11    /// It is up to the cache implementation whether that actually happens or not.
12    fn put(&mut self, pack_id: u32, offset: u64, data: &[u8], kind: git_object::Kind, compressed_size: usize);
13    /// Attempt to fetch the object at `offset` and store its decoded bytes in `out`, as previously stored with [`DecodeEntry::put()`], and return
14    /// its (object `kind`, `decompressed_size`)
15    fn get(&mut self, pack_id: u32, offset: u64, out: &mut Vec<u8>) -> Option<(git_object::Kind, usize)>;
16}
17
18/// A cache that stores nothing and retrieves nothing, thus it _never_ caches.
19#[derive(Default)]
20pub struct Never;
21
22impl DecodeEntry for Never {
23    fn put(&mut self, _pack_id: u32, _offset: u64, _data: &[u8], _kind: git_object::Kind, _compressed_size: usize) {}
24    fn get(&mut self, _pack_id: u32, _offset: u64, _out: &mut Vec<u8>) -> Option<(git_object::Kind, usize)> {
25        None
26    }
27}
28
29impl<T: DecodeEntry + ?Sized> DecodeEntry for Box<T> {
30    fn put(&mut self, pack_id: u32, offset: u64, data: &[u8], kind: Kind, compressed_size: usize) {
31        self.deref_mut().put(pack_id, offset, data, kind, compressed_size)
32    }
33
34    fn get(&mut self, pack_id: u32, offset: u64, out: &mut Vec<u8>) -> Option<(Kind, usize)> {
35        self.deref_mut().get(pack_id, offset, out)
36    }
37}
38
39/// A way of storing and retrieving entire objects to and from a cache.
40pub trait Object {
41    /// Put the object going by `id` of `kind` with `data` into the cache.
42    fn put(&mut self, id: git_hash::ObjectId, kind: git_object::Kind, data: &[u8]);
43
44    /// Try to retrieve the object named `id` and place its data into `out` if available and return `Some(kind)` if found.
45    fn get(&mut self, id: &git_hash::ObjectId, out: &mut Vec<u8>) -> Option<git_object::Kind>;
46}
47
48/// Various implementations of [`DecodeEntry`] using least-recently-used algorithms.
49#[cfg(any(feature = "pack-cache-lru-dynamic", feature = "pack-cache-lru-static"))]
50pub mod lru;
51
52pub mod object;
53
54///
55pub(crate) mod delta;
git_pack/cache/mod.rs

git_pack/cache/
mod.rs
