gitea-mirror/rosenpass
1
0
Fork 0
mirror of https://github.com/rosenpass/rosenpass.git synced 2026-02-28 06:23:08 -08:00
Code Issues Packages Projects Releases Wiki Activity

docs(result): fix docstring warnings

Browse Source 
Signed-off-by: Paul Spooren <mail@aparcar.org>
This commit is contained in:
Paul Spooren
2024-11-06 23:37:02 +01:00
parent 29e7087cb5
commit f879ad5020
1 changed files with 7 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
util/src/result.rs
View File

@@ -8,7 +8,9 @@ macro_rules! attempt {
}; };
} }
/// Trait for the ok operation, which provides a way to convert a value into a Result
pub trait OkExt<E>: Sized { pub trait OkExt<E>: Sized {
/// Wraps a value in a Result::Ok variant
fn ok(self) -> Result<Self, E>; fn ok(self) -> Result<Self, E>;
} }
@@ -25,6 +27,7 @@ impl<T, E> OkExt<E> for T {
/// ///
/// Implementations must not panic. /// Implementations must not panic.
pub trait GuaranteedValue { pub trait GuaranteedValue {
/// The value type that will be returned by guaranteed()
type Value; type Value;
/// Extract the contained value while being panic-safe, like .unwrap() /// Extract the contained value while being panic-safe, like .unwrap()
@@ -35,7 +38,11 @@ pub trait GuaranteedValue {
fn guaranteed(self) -> Self::Value; fn guaranteed(self) -> Self::Value;
} }
/// Extension trait for adding finally operation to types
pub trait FinallyExt { pub trait FinallyExt {
/// Executes a closure with mutable access to self and returns self
///
/// The closure is guaranteed to be executed before returning.
fn finally<F: FnOnce(&mut Self)>(self, f: F) -> Self; fn finally<F: FnOnce(&mut Self)>(self, f: F) -> Self;
} }