musli 0.0.149

Müsli is a flexible and efficient serialization 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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134

use core::marker::PhantomData;
use core::ptr::NonNull;

use crate::Context;
use crate::alloc::Vec;

use super::{SliceOverflow, Writer};

/// A writer into a slice.
///
/// This is typically created by using a mutable slice as a writer through
/// the [`IntoWriter`] trait.
///
/// [`IntoWriter`]: crate::writer::IntoWriter
///
/// # Examples
///
/// ```
/// use musli::writer::{IntoWriter, Writer};
/// use musli::context;
///
/// let mut buffer = [0u8; 10];
/// let mut writer = buffer.as_mut_slice().into_writer();
/// let cx = context::new();
///
/// writer.write_bytes(&cx, b"Hello")?;
/// let remaining = writer.finish(&cx)?;
///
/// assert_eq!(&buffer[..5], b"Hello");
/// assert_eq!(remaining, 5); // 5 bytes remaining in the 10-byte buffer
/// # Ok::<_, musli::context::ErrorMarker>(())
/// ```
pub struct SliceMutWriter<'a> {
    start: NonNull<u8>,
    end: NonNull<u8>,
    _marker: PhantomData<&'a mut [u8]>,
}

impl<'a> SliceMutWriter<'a> {
    pub(super) fn new(slice: &'a mut [u8]) -> Self {
        // SAFETY: The slice is valid for the duration of the writer.
        unsafe {
            let range = slice.as_mut_ptr_range();
            let start = NonNull::new_unchecked(range.start);
            let end = NonNull::new_unchecked(range.end);
            Self {
                start,
                end,
                _marker: PhantomData,
            }
        }
    }

    #[inline]
    pub(crate) fn remaining(&self) -> usize {
        self.end.as_ptr() as usize - self.start.as_ptr() as usize
    }
}

impl<'a> Writer for SliceMutWriter<'a> {
    type Ok = usize;

    type Mut<'this>
        = &'this mut SliceMutWriter<'a>
    where
        Self: 'this;

    #[inline]
    fn finish<C>(&mut self, _: C) -> Result<Self::Ok, C::Error>
    where
        C: Context,
    {
        Ok(self.remaining())
    }

    #[inline]
    fn borrow_mut(&mut self) -> Self::Mut<'_> {
        self
    }

    #[inline]
    fn extend<C>(&mut self, cx: C, buffer: Vec<u8, C::Allocator>) -> Result<(), C::Error>
    where
        C: Context,
    {
        // SAFETY: the buffer never outlives this function call.
        self.write_bytes(cx, buffer.as_slice())
    }

    #[inline]
    fn write_bytes<C>(&mut self, cx: C, bytes: &[u8]) -> Result<(), C::Error>
    where
        C: Context,
    {
        let end = self.start.as_ptr().wrapping_add(bytes.len());

        if end > self.end.as_ptr() || end < self.start.as_ptr() {
            return Err(cx.message(SliceOverflow {
                n: bytes.len(),
                capacity: self.remaining(),
            }));
        }

        // SAFETY: Construction of the writer ensures the range is valid.
        unsafe {
            self.start
                .as_ptr()
                .copy_from_nonoverlapping(bytes.as_ptr(), bytes.len());
            self.start = NonNull::new_unchecked(end);
        }

        Ok(())
    }

    #[inline]
    fn write_byte<C>(&mut self, cx: C, b: u8) -> Result<(), C::Error>
    where
        C: Context,
    {
        if self.start == self.end {
            return Err(cx.message(format_args!(
                "Buffer overflow, remaining is 0 while tried to write 1"
            )));
        }

        // SAFETY: Construction of the writer ensures the range is valid.
        unsafe {
            self.start.write(b);
            self.start = self.start.add(1);
        }

        Ok(())
    }
}