derse 0.1.34

A simple binary serialization protocol 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
96
97
98
99
100

mod bytes_array;
mod deserializer;
mod downward_bytes;
mod error;
mod impls;
mod serializer;
mod varint64;

pub use bytes_array::BytesArray;
pub use deserializer::Deserializer;
pub use downward_bytes::DownwardBytes;
pub use error::{Error, Result};
pub use serializer::Serializer;
pub use varint64::VarInt64;

pub use derse_derive::{Deserialize, Serialize};

/// A trait for serializing data.
pub trait Serialize {
    /// Serializes the data into a new `Serializer` instance.
    ///
    /// # Returns
    ///
    /// A `Result` containing the serialized data or an error.
    fn serialize<S: Serializer + Default>(&self) -> Result<S> {
        let mut serializer = S::default();
        self.serialize_to(&mut serializer)?;
        Ok(serializer)
    }

    /// Serializes the data into the given `Serializer`.
    ///
    /// # Arguments
    ///
    /// * `serializer` - The `Serializer` to serialize the data into.
    ///
    /// # Returns
    ///
    /// A `Result` indicating success or failure.
    fn serialize_to<S: Serializer>(&self, serializer: &mut S) -> Result<()>;
}

/// A trait for deserializing data.
pub trait Deserialize<'a> {
    /// Deserializes the data from a `Deserializer`.
    ///
    /// # Arguments
    ///
    /// * `der` - The `Deserializer` to deserialize the data from.
    ///
    /// # Returns
    ///
    /// A `Result` containing the deserialized data or an error.
    fn deserialize<D: Deserializer<'a>>(mut der: D) -> Result<Self>
    where
        Self: Sized,
    {
        Self::deserialize_from(&mut der)
    }

    /// Deserializes the data from the given `Deserializer`.
    ///
    /// # Arguments
    ///
    /// * `buf` - The `Deserializer` to deserialize the data from.
    ///
    /// # Returns
    ///
    /// A `Result` containing the deserialized data or an error.
    fn deserialize_from<D: Deserializer<'a>>(buf: &mut D) -> Result<Self>
    where
        Self: Sized;
}

/// A trait for detailed deserialization.
pub trait DetailedDeserialize<'a> {
    /// Deserializes the length from the given `Deserializer`.
    ///
    /// # Arguments
    ///
    /// * `buf` - The `Deserializer` to deserialize the length from.
    ///
    /// # Returns
    ///
    /// A `Result` containing the length or an error.
    fn deserialize_len<D: Deserializer<'a>>(buf: &mut D) -> Result<usize>;

    /// Deserializes the fields from the given `Deserializer`.
    ///
    /// # Arguments
    ///
    /// * `buf` - The `Deserializer` to deserialize the fields from.
    ///
    /// # Returns
    ///
    /// A `Result` containing the deserialized fields or an error.
    fn deserialize_fields<D: Deserializer<'a>>(buf: &mut D) -> Result<Self>
    where
        Self: Sized;
}