about summary refs log tree commit diff
diff options
context:
space:
mode:
authorFlorian Klink <flokli@flokli.de>2023-06-12T12·04+0300
committerflokli <flokli@flokli.de>2023-06-12T12·43+0000
commitb49f7cfec6a11816971d7d7c7cdcee3088bae7d2 (patch)
tree7ca204391c8028d3580eb818bff52feb811ec01a
parent5de04dbc12ca4de4942e9319fb7223bde54d6076 (diff)
docs(tvix/store/blobservice): fix docstrings r/6277
These are outdated.

Change-Id: I1a1ae130a55847f57a48d5e244e7e029c1ecae7b
Reviewed-on: https://cl.tvl.fyi/c/depot/+/8749
Autosubmit: flokli <flokli@flokli.de>
Tested-by: BuildkiteCI
Reviewed-by: tazjin <tazjin@tvl.su>
-rw-r--r--tvix/store/src/blobservice/mod.rs5
1 files changed, 3 insertions, 2 deletions
diff --git a/tvix/store/src/blobservice/mod.rs b/tvix/store/src/blobservice/mod.rs
index 08565285c0..d9aa15bf2a 100644
--- a/tvix/store/src/blobservice/mod.rs
+++ b/tvix/store/src/blobservice/mod.rs
@@ -13,12 +13,13 @@ pub use self::sled::SledBlobService;
 /// The base trait all BlobService services need to implement.
 /// It provides functions to check whether a given blob exists,
 /// a way to get a [io::Read] to a blob, and a method to initiate writing a new
-/// Blob, which returns a [BlobWriter], that can be used
+/// Blob, which will return something implmenting io::Write, and providing a
+/// close funtion, to finalize a blob and get its digest.
 pub trait BlobService: Send + Sync {
     /// Check if the service has the blob, by its content hash.
     fn has(&self, digest: &B3Digest) -> Result<bool, Error>;
 
-    /// Request a blob from the store, by its content hash. Returns a Option<BlobReader>.
+    /// Request a blob from the store, by its content hash.
     fn open_read(&self, digest: &B3Digest) -> Result<Option<Box<dyn io::Read + Send>>, Error>;
 
     /// Insert a new blob into the store. Returns a [BlobWriter], which