epserde 0.13.1

ε-serde is an ε-copy (i.e., almost zero-copy) serialization/deserialization framework
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

/*
 * SPDX-FileCopyrightText: 2023 Inria
 * SPDX-FileCopyrightText: 2023 Sebastiano Vigna
 *
 * SPDX-License-Identifier: Apache-2.0 OR MIT
 */

//! A cursor over a byte slice keeping track of the current position.

use super::*;
use crate::prelude::*;

/// `std::io::Cursor`-like structure for deserialization that does not
/// depend on [`std`].
///
/// Hand-written [`DeserInner`] implementations can read the still-unread
/// backing bytes with `data()` starting at the current position `pos()`, and
/// advance the cursor with `skip()`, to build ε-copy references into the
/// backing slice.
///
/// [`DeserInner`]: super::DeserInner
///
/// [`std`]: https://doc.rust-lang.org/std/
#[derive(Debug, Clone)]
#[cfg_attr(feature = "mem_dbg", derive(mem_dbg::MemDbg, mem_dbg::MemSize))]
pub struct SliceWithPos<'a> {
    /// The still-unread suffix of the backing slice; its first byte is at
    /// position `pos`.
    pub(crate) data: &'a [u8],
    /// The number of bytes already consumed from the start of the backing
    /// slice.
    pub(crate) pos: usize,
}

impl<'a> SliceWithPos<'a> {
    /// Returns a new [`SliceWithPos`] reading from `backend`, positioned at its
    /// start.
    pub const fn new(backend: &'a [u8]) -> Self {
        Self {
            data: backend,
            pos: 0,
        }
    }

    /// Returns the still-unread suffix of the backing slice.
    ///
    /// Its first byte is at the current position `pos()`.
    #[inline(always)]
    pub const fn data(&self) -> &'a [u8] {
        self.data
    }

    /// Returns the number of bytes already consumed from the start of the
    /// backing slice.
    #[inline(always)]
    pub const fn pos(&self) -> usize {
        self.pos
    }

    /// Advances the position by `bytes`, discarding them.
    ///
    /// Returns [`Error::ReadError`] if fewer than `bytes` bytes remain.
    ///
    /// [`Error::ReadError`]: super::Error::ReadError
    pub fn skip(&mut self, bytes: usize) -> deser::Result<()> {
        self.data = self.data.get(bytes..).ok_or(Error::ReadError)?;
        self.pos += bytes;
        Ok(())
    }
}

impl ReadNoStd for SliceWithPos<'_> {
    fn read_exact(&mut self, buf: &mut [u8]) -> deser::Result<()> {
        let len = buf.len();
        if len > self.data.len() {
            return Err(Error::ReadError);
        }
        buf.copy_from_slice(&self.data[..len]);
        self.data = &self.data[len..];
        self.pos += len;
        Ok(())
    }
}

impl ReadWithPos for SliceWithPos<'_> {
    fn pos(&self) -> usize {
        self.pos
    }

    /// Pads the cursor to the correct alignment.
    ///
    /// Note that this method also checks that the absolute memory position is
    /// properly aligned.
    fn align<T: PadTo>(&mut self) -> deser::Result<()> {
        let pad_to = T::pad_to();
        // Zero-sized types impose no alignment
        if pad_to == 0 {
            return Ok(());
        }
        // Skip bytes as needed
        let padding = crate::pad_align_to(self.pos, pad_to);
        self.skip(padding)?;
        // Check that the ptr is indeed aligned
        if self.data.as_ptr() as usize % pad_to != 0 {
            Err(Error::AlignmentError)
        } else {
            Ok(())
        }
    }
}