Skip to content

Commit cddc8e7

Browse files
committed
f update docs about fallibility on reading monitors
1 parent 9075c1d commit cddc8e7

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

lightning/src/util/persist.rs

+5-5
Original file line numberDiff line numberDiff line change
@@ -333,11 +333,11 @@ where
333333
/// ## EXTREMELY IMPORTANT
334334
///
335335
/// It is extremely important that your [`KVStore::read`] implementation uses the
336-
/// [`io::ErrorKind::NotFound`] variant correctly: that is, when a file is not found, and _only_
337-
/// in that circumstance (not when there is really a permissions error, for example). This is
338-
/// because this function does not list updates. Instead, it reads the monitor, and using its
339-
/// stored `update_id`, synthesizes update storage keys, and tries them in sequence until one is
340-
/// not found. All _other_ errors will be bubbled up in this function's [`io::Result`].
336+
/// [`io::ErrorKind::NotFound`] variant correctly: that is, when a file is not found, and _only_ in
337+
/// that circumstance (not when there is really a permissions error, for example). This is because
338+
/// neither channel monitor reading function lists updates. Instead, either reads the monitor, and
339+
/// using its stored `update_id`, synthesizes update storage keys, and tries them in sequence until
340+
/// one is not found. All _other_ errors will be bubbled up in the function's [`Result`].
341341
///
342342
/// # Pruning stale channel updates
343343
///

0 commit comments

Comments
 (0)