tvix/store/src/chunkservice/mod.rs


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

mod util;

pub mod memory;
pub mod sled;

use crate::Error;

pub use self::memory::MemoryChunkService;
pub use self::sled::SledChunkService;
pub use self::util::read_all_and_chunk;
pub use self::util::update_hasher;
pub use self::util::upload_chunk;

/// The base trait all ChunkService services need to implement.
/// It allows checking for the existence, download and upload of chunks.
/// It's usually used after consulting a [crate::blobservice::BlobService] for
/// chunking information.
pub trait ChunkService {
    /// check if the service has a chunk, given by its digest.
    fn has(&self, digest: &[u8]) -> Result<bool, Error>;

    /// retrieve a chunk by its digest. Implementations MUST validate the digest
    /// matches.
    fn get(&self, digest: &[u8]) -> Result<Option<Vec<u8>>, Error>;

    /// insert a chunk. returns the digest of the chunk, or an error.
    fn put(&self, data: Vec<u8>) -> Result<Vec<u8>, Error>;
}