about summary refs log tree commit diff
path: root/tvix/store/src/import.rs
diff options
context:
space:
mode:
authorFlorian Klink <flokli@flokli.de>2023-05-17T11·21+0300
committerclbot <clbot@tvl.fyi>2023-05-17T13·06+0000
commit3a4e29c26141a24caa71a0dbaf40a6f8d1c2adef (patch)
tree32e2b8d73e38ea838914cdb27c7d7bca412d8581 /tvix/store/src/import.rs
parenta6c7869393930c667e837b99cd36e0d8e9eb2498 (diff)
refactor(tvix/store): rename import::{import_path -> ingest_path} r/6149
This distinguishes it better from the EvalIO::import_path method.
Also update the docstring to explain what it does (and what it doesn't).

Change-Id: I32a8b2869fa67a894df28532b22bf170961a2abf
Reviewed-on: https://cl.tvl.fyi/c/depot/+/8578
Reviewed-by: tazjin <tazjin@tvl.su>
Autosubmit: flokli <flokli@flokli.de>
Tested-by: BuildkiteCI
Diffstat (limited to 'tvix/store/src/import.rs')
-rw-r--r--tvix/store/src/import.rs13
1 files changed, 7 insertions, 6 deletions
diff --git a/tvix/store/src/import.rs b/tvix/store/src/import.rs
index bf80eb4b71..ade700a6c2 100644
--- a/tvix/store/src/import.rs
+++ b/tvix/store/src/import.rs
@@ -136,14 +136,15 @@ fn process_entry<BS: BlobService, DP: DirectoryPutter>(
     todo!("handle other types")
 }
 
-/// Imports the contents at a given Path into the tvix store.
+/// Ingests the contents at the given path into the tvix store,
+/// interacting with a [BlobService] and [DirectoryService].
+/// It returns the root node or an error.
 ///
-/// It doesn't register the contents at a Path in the store itself, that's up
-/// to the PathInfoService.
-//
-// returns the root node, or an error.
+/// It's not interacting with a [PathInfoService], it's up to the caller to
+/// possibly register it somewhere (and potentially rename it based on some
+/// naming scheme.
 #[instrument(skip(blob_service, directory_service), fields(path=?p))]
-pub fn import_path<BS: BlobService, DS: DirectoryService, P: AsRef<Path> + Debug>(
+pub fn ingest_path<BS: BlobService, DS: DirectoryService, P: AsRef<Path> + Debug>(
     blob_service: &mut BS,
     directory_service: &mut DS,
     p: P,