a9f453f6da
Extend the docstrings of `add_default_services`, and add one for `addrs_to_configs` as well as the module-wide one at `tvix_store::composition`. Change-Id: Ie9b449988eb210cd65b19b174094bbe0c4af2fd6 Reviewed-on: https://cl.tvl.fyi/c/depot/+/12748 Tested-by: BuildkiteCI Reviewed-by: yuka <yuka@yuka.dev>
30 lines
1.3 KiB
Rust
30 lines
1.3 KiB
Rust
//! 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);
|
|
}
|