From b49f7cfec6a11816971d7d7c7cdcee3088bae7d2 Mon Sep 17 00:00:00 2001 From: Florian Klink Date: Mon, 12 Jun 2023 15:04:36 +0300 Subject: docs(tvix/store/blobservice): fix docstrings These are outdated. Change-Id: I1a1ae130a55847f57a48d5e244e7e029c1ecae7b Reviewed-on: https://cl.tvl.fyi/c/depot/+/8749 Autosubmit: flokli Tested-by: BuildkiteCI Reviewed-by: tazjin --- tvix/store/src/blobservice/mod.rs | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) (limited to 'tvix/store/src/blobservice/mod.rs') diff --git a/tvix/store/src/blobservice/mod.rs b/tvix/store/src/blobservice/mod.rs index 08565285c0d1..d9aa15bf2a46 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; - /// Request a blob from the store, by its content hash. Returns a Option. + /// Request a blob from the store, by its content hash. fn open_read(&self, digest: &B3Digest) -> Result>, Error>; /// Insert a new blob into the store. Returns a [BlobWriter], which -- cgit 1.4.1