1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74

use crate::{
    check_archived_root,
    de::deserializers::SharedDeserializeMap,
    validation::validators::{CheckTypeError, DefaultValidator},
    Archive, Deserialize, Fallible,
};
use ::bytecheck::CheckBytes;
use ::core::fmt;

/// Errors that can occur while deserializing from bytes.
#[derive(Debug)]
pub enum CheckDeserializeError<C, D> {
    /// A validation error occurred.
    CheckBytesError(C),
    /// A deserialization error occurred.
    DeserializeError(D),
}

impl<C: fmt::Display, D: fmt::Display> fmt::Display for CheckDeserializeError<C, D> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::CheckBytesError(e) => write!(f, "{}", e),
            Self::DeserializeError(e) => write!(f, "{}", e),
        }
    }
}

#[cfg(feature = "std")]
const _: () = {
    use ::std::error::Error;

    impl<C: Error + 'static, D: Error + 'static> Error for CheckDeserializeError<C, D> {
        fn source(&self) -> Option<&(dyn Error + 'static)> {
            match self {
                Self::CheckBytesError(e) => Some(e as &dyn Error),
                Self::DeserializeError(e) => Some(e as &dyn Error),
            }
        }
    }
};

/// The error type for [`from_bytes`].
pub type FromBytesError<'a, T> = CheckDeserializeError<
    CheckTypeError<<T as Archive>::Archived, DefaultValidator<'a>>,
    <SharedDeserializeMap as Fallible>::Error,
>;

/// Checks and deserializes a value from the given bytes.
///
/// This function is only available with the `alloc` and `validation` features because it uses a
/// general-purpose deserializer and performs validation on the data before deserializing. In
/// no-alloc and high-performance environments, the deserializer should be customized for the
/// specific situation.
///
/// # Examples
/// ```
/// let value = vec![1, 2, 3, 4];
///
/// let bytes = rkyv::to_bytes::<_, 1024>(&value).expect("failed to serialize vec");
/// let deserialized = rkyv::from_bytes::<Vec<i32>>(&bytes).expect("failed to deserialize vec");
///
/// assert_eq!(deserialized, value);
/// ```
#[inline]
pub fn from_bytes<'a, T>(bytes: &'a [u8]) -> Result<T, FromBytesError<'a, T>>
where
    T: Archive,
    T::Archived: 'a + CheckBytes<DefaultValidator<'a>> + Deserialize<T, SharedDeserializeMap>,
{
    check_archived_root::<'a, T>(bytes)
        .map_err(CheckDeserializeError::CheckBytesError)?
        .deserialize(&mut SharedDeserializeMap::default())
        .map_err(CheckDeserializeError::DeserializeError)
}