Unverified Commit 33cb920b authored by Bastian Köcher's avatar Bastian Köcher Committed by GitHub
Browse files

Fix some docs (#246)

parent 5f7145db
Pipeline #121630 failed with stages
in 17 minutes and 18 seconds
...@@ -20,8 +20,9 @@ pub(crate) const DECODE_ALL_ERR_MSG: &str = "Input buffer has still data left af ...@@ -20,8 +20,9 @@ pub(crate) const DECODE_ALL_ERR_MSG: &str = "Input buffer has still data left af
/// Extension trait to [`Decode`] that ensures that the given input data is consumed completly while /// Extension trait to [`Decode`] that ensures that the given input data is consumed completly while
/// decoding. /// decoding.
pub trait DecodeAll: Sized { pub trait DecodeAll: Sized {
/// Decode `Self` and consume all of the given input data. If not all data is consumed, an error /// Decode `Self` and consume all of the given input data.
/// is returned. ///
/// If not all data is consumed, an error is returned.
fn decode_all(input: &[u8]) -> Result<Self, Error>; fn decode_all(input: &[u8]) -> Result<Self, Error>;
} }
......
...@@ -17,14 +17,16 @@ use crate::codec::{Error, Decode, Input}; ...@@ -17,14 +17,16 @@ use crate::codec::{Error, Decode, Input};
/// The error message returned when depth limit is reached. /// The error message returned when depth limit is reached.
const DECODE_MAX_DEPTH_MSG: &str = "Maximum recursion depth reached when decoding"; const DECODE_MAX_DEPTH_MSG: &str = "Maximum recursion depth reached when decoding";
/// Extension trait to [`Decode`] that ensures that the given input data is consumed completly while /// Extension trait to [`Decode`] for decoding with a maximum recursion depth.
/// decoding.
pub trait DecodeLimit: Sized { pub trait DecodeLimit: Sized {
/// Decode `Self` with given maximum recursion depth. /// Decode `Self` with the given maximum recursion depth.
/// is returned. ///
/// If `limit` is hit, an error is returned.
fn decode_with_depth_limit(limit: u32, input: &[u8]) -> Result<Self, Error>; fn decode_with_depth_limit(limit: u32, input: &[u8]) -> Result<Self, Error>;
/// Decode `Self` and consume all of the given input data. If not all data is consumed, an error
/// is returned. /// Decode `Self` and consume all of the given input data.
///
/// If not all data is consumed or `limit` is hit, an error is returned.
fn decode_all_with_depth_limit(limit: u32, input: &[u8]) -> Result<Self, Error>; fn decode_all_with_depth_limit(limit: u32, input: &[u8]) -> Result<Self, Error>;
} }
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment