Struct tvix_castore::directoryservice::ObjectStoreDirectoryService

pub struct ObjectStoreDirectoryService {
    instance_name: String,
    object_store: Arc<dyn ObjectStore>,
    base_path: Path,
}

Stores directory closures in an object store. Notably, this makes use of the option to disallow accessing child directories except when fetching them recursively via the top-level directory, since all batched writes (using put_multiple_start) are stored in a single object. Directories are stored in a length-delimited format with a 1MiB limit. The length field is a u32 and the directories are stored in root-to-leaves topological order, the same way they will be returned to the client in get_recursive.

Fields

instance_name: String

object_store: Arc<dyn ObjectStore>

base_path: Path

Implementations

impl ObjectStoreDirectoryService

pub fn parse_url_opts<I, K, V>(url: &Url, options: I) -> Result<Self, Error>

where I: IntoIterator<Item = (K, V)>, K: AsRef<str>, V: Into<String>,

Constructs a new ObjectStoreDirectoryService from a Url supported by object_store. Any path suffix becomes the base path of the object store. additional options, the same as in object_store::parse_url_opts can be passed.

pub fn parse_url(url: &Url) -> Result<Self, Error>

Like Self::parse_url_opts, except without the options.

pub fn new( instance_name: String, object_store: Arc<dyn ObjectStore>, base_path: Path, ) -> Self

Trait Implementations

impl Clone for ObjectStoreDirectoryService

fn clone(&self) -> ObjectStoreDirectoryService

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl DirectoryService for ObjectStoreDirectoryService

fn get<'life0, 'life1, 'async_trait>( &'life0 self, digest: &'life1 B3Digest, ) -> Pin<Box<dyn Future<Output = Result<Option<Directory>, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

This is the same steps as for get_recursive anyways, so we just call get_recursive and return the first element of the stream and drop the request.

fn put<'life0, 'async_trait>( &'life0 self, directory: Directory, ) -> Pin<Box<dyn Future<Output = Result<B3Digest, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Uploads a single Directory message, and returns the calculated digest, or an error. An error must also be returned if the message is not valid.

fn get_recursive( &self, root_directory_digest: &B3Digest, ) -> BoxStream<'static, Result<Directory, Error>>

Looks up a closure of Directory. Ideally this would be a impl Stream<Item = Result<Directory, Error>>, and we’d be able to add a default implementation for it here, but we can’t have that yet.

fn put_multiple_start(&self) -> Box<dyn DirectoryPutter + 'static>

where Self: Clone,

Allows persisting a closure of Directory, which is a graph of connected Directory messages.