aboutsummaryrefslogtreecommitdiff
path: root/src/lib.rs
diff options
context:
space:
mode:
authorHampusM <hampus@hampusmat.com>2023-05-14 17:24:07 +0200
committerHampusM <hampus@hampusmat.com>2023-05-14 17:24:07 +0200
commit221fce68e36bf1926e93180bd4467f42cb1774d6 (patch)
treea266e8023cbbb8a3cf51dbc65878e2e3410e7882 /src/lib.rs
parent2e4f293cee28cd5fb62ed5e8c95472764f5f5143 (diff)
docs: add error docs to the ResultExt try_event function
Diffstat (limited to 'src/lib.rs')
-rw-r--r--src/lib.rs3
1 files changed, 3 insertions, 0 deletions
diff --git a/src/lib.rs b/src/lib.rs
index c07e0a1..5235e54 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -31,6 +31,9 @@ pub trait DeserializeTagged: Sized + MaybeStatic
pub trait ResultExt<Value, DeError>
{
/// Returns `Ok(None)` if `Err` is `DeserializerError::UnexpectedEvent`.
+ ///
+ /// # Errors
+ /// Returns `Err` if a `Deserializer` error occurs.
fn try_event(self) -> Result<Option<Value>, DeserializerError<DeError>>;
}