Skip to content

Commit 58fc84d

Browse files
committed
Improve docs in io/io::KVStore
1 parent dd2570f commit 58fc84d

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

@@ -52,9 +54,10 @@ pub trait KVStore: KVStorePersister {
5254
/// Returns a [`Read`] for the given `namespace` and `key` from which [`Readable`]s may be
5355
/// read.
5456
///
55-
/// Returns an `Err` if the given `key` could not be found in the given `namespace`.
57+
/// Returns an [`ErrorKind::NotFound`] if the given `key` could not be found in the given `namespace`.
5658
///
5759
/// [`Readable`]: lightning::util::ser::Readable
60+
/// [`ErrorKind::NotFound`]: std::io::ErrorKind::NotFound
5861
fn read(&self, namespace: &str, key: &str) -> std::io::Result<Self::Reader>;
5962
/// Persists the given data under the given `key`.
6063
///

0 commit comments

Comments
 (0)