diff options
Diffstat (limited to 'tvix/store/src/composition.rs')
-rw-r--r-- | tvix/store/src/composition.rs | 17 |
1 files changed, 13 insertions, 4 deletions
diff --git a/tvix/store/src/composition.rs b/tvix/store/src/composition.rs index 063236136fd1..ce35cc2fcac2 100644 --- a/tvix/store/src/composition.rs +++ b/tvix/store/src/composition.rs @@ -1,6 +1,13 @@ +//! 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; -pub use tvix_castore::composition::*; +use tvix_castore::composition::Registry; /// The provided registry of tvix_store, which has all the builtin /// tvix_castore (BlobStore/DirectoryStore) and tvix_store @@ -12,9 +19,11 @@ pub static REG: LazyLock<&'static Registry> = LazyLock::new(|| { Box::leak(Box::new(reg)) }); -/// Register the builtin services of tvix_castore and tvix_store with the given -/// registry. This is useful for creating your own registry with the builtin -/// types _and_ extra third party types. +/// 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); |