path: root/tvix/store/src/blobservice/mod.rs

use std::io;

use crate::{B3Digest, Error};

mod dumb_seeker;
mod from_addr;
mod grpc;
mod memory;
mod sled;

#[cfg(test)]
mod tests;

pub use self::from_addr::from_addr;
pub use self::grpc::GRPCBlobService;
pub use self::memory::MemoryBlobService;
pub use self::sled::SledBlobService;

/// The base trait all BlobService services need to implement.
/// It provides functions to check whether a given blob exists,
/// a way to get a [io::Read] to a blob, and a method to initiate writing a new
/// Blob, which will return something implmenting io::Write, and providing a
/// close funtion, to finalize a blob and get its digest.
pub trait BlobService: Send + Sync {
    /// Create a new instance by passing in a connection URL.
    fn from_url(url: &url::Url) -> Result<Self, Error>
    where
        Self: Sized;

    /// Check if the service has the blob, by its content hash.
    fn has(&self, digest: &B3Digest) -> Result<bool, Error>;

    /// Request a blob from the store, by its content hash.
    fn open_read(&self, digest: &B3Digest) -> Result<Option<Box<dyn BlobReader>>, Error>;

    /// Insert a new blob into the store. Returns a [BlobWriter], which
    /// implements [io::Write] and a [BlobWriter::close].
    fn open_write(&self) -> Box<dyn BlobWriter>;
}

/// A [io::Write] that you need to close() afterwards, and get back the digest
/// of the written blob.
pub trait BlobWriter: io::Write + Send + Sync + 'static {
    /// Signal there's no more data to be written, and return the digest of the
    /// contents written.
    ///
    /// Closing a already-closed BlobWriter is a no-op.
    fn close(&mut self) -> Result<B3Digest, Error>;
}

/// A [io::Read] that also allows seeking.
pub trait BlobReader: io::Read + io::Seek + Send + 'static {}

/// A Cursor<Vec<u8>> can be used as a BlobReader.
impl BlobReader for io::Cursor<Vec<u8>> {}