heddle-objects 0.5.0

An AI-native version control system
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

// SPDX-License-Identifier: Apache-2.0
//! Read-only object source traits for graph walkers.

use crate::{
    object::{Blob, ChangeId, ContentHash, State, Tree},
    store::ObjectStore,
};

use super::Result;

/// Read-only subset of [`ObjectStore`] needed by object graph walkers.
pub trait ObjectSource {
    fn get_tree(&self, hash: &ContentHash) -> Result<Option<Tree>>;
    fn get_state(&self, id: &ChangeId) -> Result<Option<State>>;
    fn get_blob(&self, hash: &ContentHash) -> Result<Option<Blob>>;

    /// Zero-copy variant of `get_blob`.
    fn get_blob_bytes(&self, hash: &ContentHash) -> Result<Option<bytes::Bytes>> {
        Ok(self
            .get_blob(hash)?
            .map(|blob| bytes::Bytes::from(blob.into_content())))
    }
}

impl<S: ObjectStore + ?Sized> ObjectSource for S {
    #[inline]
    fn get_tree(&self, hash: &ContentHash) -> Result<Option<Tree>> {
        ObjectStore::get_tree(self, hash)
    }

    #[inline]
    fn get_state(&self, id: &ChangeId) -> Result<Option<State>> {
        ObjectStore::get_state(self, id)
    }

    #[inline]
    fn get_blob(&self, hash: &ContentHash) -> Result<Option<Blob>> {
        ObjectStore::get_blob(self, hash)
    }

    #[inline]
    fn get_blob_bytes(&self, hash: &ContentHash) -> Result<Option<bytes::Bytes>> {
        ObjectStore::get_blob_bytes(self, hash)
    }
}

#[cfg(feature = "async-source")]
#[allow(async_fn_in_trait)]
pub trait AsyncObjectSource {
    async fn get_tree(&self, hash: &ContentHash) -> Result<Option<Tree>>;
    async fn get_state(&self, id: &ChangeId) -> Result<Option<State>>;
    async fn get_blob(&self, hash: &ContentHash) -> Result<Option<Blob>>;
}