planus 1.1.1

Planus is an alternative compiler for flatbuffers, an efficient cross platform serialization library.
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
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159

use core::mem::MaybeUninit;

use crate::{
    builder::Builder, errors::ErrorKind, slice_helpers::SliceWithStartOffset, traits::*, Cursor,
    Offset,
};

impl WriteAsOffset<str> for str {
    #[inline]
    #[allow(clippy::let_and_return)]
    fn prepare(&self, builder: &mut Builder) -> Offset<str> {
        #[cfg(feature = "string-cache")]
        let hash = {
            let hash = builder.string_cache.hash(self.as_bytes());
            if let Some(offset) =
                builder
                    .string_cache
                    .get(builder.inner.as_slice(), hash, self.as_bytes())
            {
                return offset.into();
            }
            hash
        };

        let size_including_len_and_null = self.len().checked_add(5).unwrap();
        // SAFETY: We make sure to write the 4+len+1 bytes inside the closure
        unsafe {
            builder.write_with(
                size_including_len_and_null,
                u32::ALIGNMENT_MASK,
                |buffer_position, bytes| {
                    let bytes = bytes.as_mut_ptr();

                    (self.len() as u32).write(
                        Cursor::new(&mut *(bytes as *mut [MaybeUninit<u8>; 4])),
                        buffer_position,
                    );
                    core::ptr::copy_nonoverlapping(
                        self.as_bytes().as_ptr() as *const MaybeUninit<u8>,
                        bytes.add(4),
                        self.len(),
                    );
                    bytes.add(4 + self.len()).write(MaybeUninit::new(0));
                },
            )
        }
        let offset = builder.current_offset();

        #[cfg(feature = "string-cache")]
        builder
            .string_cache
            .insert(hash, offset.into(), builder.inner.as_slice());

        offset
    }
}

impl WriteAs<Offset<str>> for str {
    type Prepared = Offset<str>;

    #[inline]
    fn prepare(&self, builder: &mut Builder) -> Offset<str> {
        WriteAsOffset::prepare(self, builder)
    }
}

impl WriteAsOptional<Offset<str>> for str {
    type Prepared = Offset<str>;
    #[inline]
    fn prepare(&self, builder: &mut Builder) -> Option<Offset<str>> {
        Some(WriteAsOffset::prepare(self, builder))
    }
}

impl WriteAsDefault<Offset<str>, str> for str {
    type Prepared = Offset<str>;

    #[inline]
    fn prepare(&self, builder: &mut Builder, default: &str) -> Option<Offset<str>> {
        if self == default {
            None
        } else {
            Some(WriteAsOffset::prepare(self, builder))
        }
    }
}

impl<'buf> TableRead<'buf> for &'buf str {
    fn from_buffer(
        buffer: SliceWithStartOffset<'buf>,
        offset: usize,
    ) -> core::result::Result<Self, ErrorKind> {
        let (buffer, len) = super::array_from_buffer(buffer, offset)?;
        #[cfg(feature = "extra-validation")]
        if buffer.as_slice().get(len) != Some(&0) {
            return Err(ErrorKind::MissingNullTerminator);
        }
        let slice = buffer
            .as_slice()
            .get(..len)
            .ok_or(ErrorKind::InvalidLength)?;
        Ok(core::str::from_utf8(slice)?)
    }
}

impl<'buf> VectorReadInner<'buf> for &'buf str {
    type Error = crate::errors::Error;

    const STRIDE: usize = 4;
    #[inline]
    unsafe fn from_buffer(
        buffer: SliceWithStartOffset<'buf>,
        offset: usize,
    ) -> crate::Result<&'buf str> {
        let add_context =
            |e: ErrorKind| e.with_error_location("[str]", "get", buffer.offset_from_start);
        let (slice, len) = super::array_from_buffer(buffer, offset).map_err(add_context)?;
        #[cfg(feature = "extra-validation")]
        if slice.as_slice().get(len) != Some(&0) {
            return Err(add_context(ErrorKind::MissingNullTerminator));
        }
        let slice = slice
            .as_slice()
            .get(..len)
            .ok_or(ErrorKind::InvalidLength)
            .map_err(add_context)?;
        let str = core::str::from_utf8(slice)
            .map_err(|source| ErrorKind::InvalidUtf8 { source })
            .map_err(add_context)?;
        Ok(str)
    }
}

/// # Safety
/// The implementation of `write_values` initializes all the bytes.
unsafe impl VectorWrite<Offset<str>> for str {
    type Value = Offset<str>;

    const STRIDE: usize = 4;
    #[inline]
    fn prepare(&self, builder: &mut Builder) -> Self::Value {
        WriteAs::prepare(self, builder)
    }

    #[inline]
    unsafe fn write_values(
        values: &[Offset<str>],
        bytes: *mut MaybeUninit<u8>,
        buffer_position: u32,
    ) {
        let bytes = bytes as *mut [MaybeUninit<u8>; 4];
        for (i, v) in values.iter().enumerate() {
            v.write(
                Cursor::new(&mut *bytes.add(i)),
                buffer_position - (4 * i) as u32,
            );
        }
    }
}