Skip to content

Commit 98b4bc1

Browse files
committed
Improve docs in io/io::KVStore
1 parent 88af31d commit 98b4bc1

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

src/io/mod.rs

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
//! Objects and traits for data persistence.
2+
13
pub(crate) mod fs_store;
24
pub(crate) mod utils;
35

@@ -48,9 +50,10 @@ pub trait KVStore: KVStorePersister {
4850
/// Returns a [`Read`] for the given `namespace` and `key` from which [`Readable`]s may be
4951
/// read.
5052
///
51-
/// Returns an `Err` if the given `key` could not be found in the given `namespace`.
53+
/// Returns an [`ErrorKind::NotFound`] if the given `key` could not be found in the given `namespace`.
5254
///
5355
/// [`Readable`]: lightning::util::ser::Readable
56+
/// [`ErrorKind::NotFound`]: std::io::ErrorKind::NotFound
5457
fn read(&self, namespace: &str, key: &str) -> std::io::Result<Self::Reader>;
5558
/// Persists the given data under the given `key`.
5659
///

0 commit comments

Comments
 (0)