tvix/store/src/composition.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
29
30

//! This module provides a registry knowing about {Blob,Directory,PathInfo}
//! Services, as well as the [add_default_services] helper to seed new
//! registries with everything known here.
//! The composition machinery itself is defined in
//! [tvix_castore::composition], which works generically with different kinds
//! of services.

use std::sync::LazyLock;

use tvix_castore::composition::Registry;

/// The provided registry of tvix_store, which has all the builtin
/// tvix_castore (BlobStore/DirectoryStore) and tvix_store
/// (PathInfoService) implementations.
pub static REG: LazyLock<&'static Registry> = LazyLock::new(|| {
    let mut reg = Default::default();
    add_default_services(&mut reg);
    // explicitly leak to get an &'static, so that we gain `&Registry: Send` from `Registry: Sync`
    Box::leak(Box::new(reg))
});

/// Register the builtin services of tvix_castore (blob services and directory
/// services), as well as the ones from tvix_store (PathInfo service) with the
/// given registry.
/// This can be used outside to create your own registry with the builtin types
/// _and_ extra third party types.
pub fn add_default_services(reg: &mut Registry) {
    tvix_castore::composition::add_default_services(reg);
    crate::pathinfoservice::register_pathinfo_services(reg);
}