rkyv 0.8.16

Zero-copy deserialization framework for Rust
Documentation 
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
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95

use core::ffi::CStr;

use rancor::{Fallible, ResultExt, Source};

use crate::{
    alloc::{
        alloc::{alloc, handle_alloc_error},
        boxed::Box,
        ffi::CString,
    },
    ffi::{ArchivedCString, CStringResolver},
    ser::Writer,
    traits::LayoutRaw,
    Archive, Deserialize, DeserializeUnsized, Place, Serialize,
};

// CString

impl Archive for CString {
    type Archived = ArchivedCString;
    type Resolver = CStringResolver;

    #[inline]
    fn resolve(&self, resolver: Self::Resolver, out: Place<Self::Archived>) {
        ArchivedCString::resolve_from_c_str(self.as_c_str(), resolver, out);
    }
}

impl<S: Fallible + Writer + ?Sized> Serialize<S> for CString {
    fn serialize(
        &self,
        serializer: &mut S,
    ) -> Result<Self::Resolver, S::Error> {
        ArchivedCString::serialize_from_c_str(self.as_c_str(), serializer)
    }
}

impl<D> Deserialize<CString, D> for ArchivedCString
where
    D: Fallible + ?Sized,
    D::Error: Source,
    CStr: DeserializeUnsized<CStr, D>,
{
    fn deserialize(&self, deserializer: &mut D) -> Result<CString, D::Error> {
        let metadata = self.as_c_str().deserialize_metadata();
        let layout = <CStr as LayoutRaw>::layout_raw(metadata).into_error()?;
        let data_address = if layout.size() > 0 {
            let ptr = unsafe { alloc(layout) };
            if ptr.is_null() {
                handle_alloc_error(layout);
            }
            ptr
        } else {
            crate::polyfill::dangling(&layout).as_ptr()
        };
        let out = ptr_meta::from_raw_parts_mut(data_address.cast(), metadata);
        unsafe {
            self.as_c_str().deserialize_unsized(deserializer, out)?;
        }
        let boxed = unsafe { Box::<CStr>::from_raw(out) };
        Ok(CString::from(boxed))
    }
}

impl PartialEq<CString> for ArchivedCString {
    #[inline]
    fn eq(&self, other: &CString) -> bool {
        PartialEq::eq(self.as_c_str(), other.as_c_str())
    }
}

impl PartialEq<ArchivedCString> for CString {
    #[inline]
    fn eq(&self, other: &ArchivedCString) -> bool {
        PartialEq::eq(other.as_c_str(), self.as_c_str())
    }
}

#[cfg(test)]
mod tests {
    use crate::{
        alloc::{ffi::CString, string::String},
        api::test::roundtrip,
    };

    #[test]
    fn roundtrip_c_string() {
        let value = unsafe {
            CString::from_vec_unchecked(
                String::from("hello world").into_bytes(),
            )
        };
        roundtrip(&value);
    }
}