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

//! Wrapper for integrating musli with I/O types like [std::io].
//!
//! The main methods in this module is the [`wrap`] function which constructs an
//! adapter around an I/O type to work with musli.

#[cfg(feature = "std")]
use crate::Context;
#[cfg(feature = "std")]
use crate::alloc::Vec;

/// Wrap a type so that it implements [`Reader`] and [`Writer`].
///
/// See [`wrap()`].
///
/// [`Reader`]: crate::reader::Reader
/// [`Writer`]: crate::writer::Writer
///
/// # Examples
///
/// ```
/// use musli::wrap;
///
/// let buffer: Vec<u8> = Vec::new();
/// let wrapped = wrap::wrap(buffer);
/// ```
pub struct Wrap<T> {
    #[cfg_attr(not(feature = "std"), allow(unused))]
    inner: T,
}

/// Wrap a type so that it implements [`Reader`] and [`Writer`].
///
/// [`Reader`]: crate::reader::Reader
/// [`Writer`]: crate::writer::Writer
///
/// # Examples
///
/// ```
/// use musli::wrap;
///
/// let buffer: Vec<u8> = Vec::new();
/// let wrapped = wrap::wrap(buffer);
/// ```
#[inline]
pub fn wrap<T>(inner: T) -> Wrap<T> {
    Wrap { inner }
}

#[cfg(feature = "std")]
impl<W> crate::writer::IntoWriter for Wrap<W>
where
    W: std::io::Write,
{
    type Ok = ();
    type Writer = Self;

    #[inline]
    fn into_writer(self) -> Self::Writer {
        self
    }
}

#[cfg(feature = "std")]
impl<W> crate::writer::Writer for Wrap<W>
where
    W: std::io::Write,
{
    type Ok = ();
    type Mut<'this>
        = &'this mut Self
    where
        Self: 'this;

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

    #[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,
    {
        self.inner.write_all(bytes).map_err(cx.map())?;
        cx.advance(bytes.len());
        Ok(())
    }
}