feat: add function to decode an entire slice

CHANGELOG.md

@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- `decode_full` function ([#23])
+
+[#23]: https://github.com/alloy-rs/rlp/pull/23
+
 ## [0.3.7] - 2024-06-29
 
 ### Fixed

crates/rlp/src/decode.rs

@@ -176,6 +176,24 @@ mod std_impl {
     }
 }
 
+/// Decodes the entire input, ensuring no trailing bytes remain.
+///
+/// # Errors
+///
+/// Returns an error if the encoding is invalid or if data remains after decoding the RLP item.
+#[inline]
+pub fn decode_full<T: Decodable>(bytes: impl AsRef<[u8]>) -> Result<T> {
+    let mut buf = bytes.as_ref();
+    let out = T::decode(&mut buf)?;
+
+    // check if there are any remaining bytes after decoding
+    if !buf.is_empty() {
+        return Err(Error::TrailingBytes);
+    }
+
+    Ok(out)
+}
+
 /// Left-pads a slice to a statically known size array.
 ///
 /// # Errors
@@ -211,7 +229,7 @@ fn slice_to_array<const N: usize>(slice: &[u8]) -> Result<[u8; N]> {
 #[cfg(test)]
 mod tests {
     use super::*;
-    use crate::Encodable;
+    use crate::{encode, Encodable};
     use core::fmt::Debug;
     use hex_literal::hex;
 
@@ -344,4 +362,18 @@ mod tests {
         check_decode::<u8, _>([(Err(Error::InputTooShort), &hex!("82")[..])]);
         check_decode::<u64, _>([(Err(Error::InputTooShort), &hex!("82")[..])]);
     }
+
+    #[test]
+    fn rlp_full() {
+        fn check_decode_full<T: Decodable + Encodable + PartialEq + Debug>(input: T) {
+            let encoded = encode(&input);
+            assert_eq!(decode_full::<T>(&encoded), Ok(input));
+            assert_eq!(decode_full::<T>([encoded, vec![0x00]].concat()), Err(Error::TrailingBytes));
+        }
+
+        check_decode_full::<String>("".into());
+        check_decode_full::<String>("test1234".into());
+        check_decode_full::<Vec<u64>>(vec![]);
+        check_decode_full::<Vec<u64>>(vec![0; 4]);
+    }
 }

crates/rlp/src/error.rs

@@ -12,6 +12,8 @@ pub enum Error {
     LeadingZero,
     /// Overran input while decoding.
     InputTooShort,
+    /// Additional trailing bytes found after decoding.
+    TrailingBytes,
     /// Expected single byte, but got invalid value.
     NonCanonicalSingleByte,
     /// Expected size, but got invalid value.
@@ -42,6 +44,7 @@ impl fmt::Display for Error {
             Self::Overflow => f.write_str("overflow"),
             Self::LeadingZero => f.write_str("leading zero"),
             Self::InputTooShort => f.write_str("input too short"),
+            Self::TrailingBytes => f.write_str("trailing bytes"),
             Self::NonCanonicalSingleByte => f.write_str("non-canonical single byte"),
             Self::NonCanonicalSize => f.write_str("non-canonical size"),
             Self::UnexpectedLength => f.write_str("unexpected length"),

crates/rlp/src/lib.rs

@@ -19,7 +19,7 @@
 extern crate alloc;
 
 mod decode;
-pub use decode::{Decodable, Rlp};
+pub use decode::{decode_full, Decodable, Rlp};
 
 mod error;
 pub use error::{Error, Result};