bromine 0.22.1

A flexible ipc protocol (previously rmp-ipc)
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
160

use bytes::Bytes;
use serde::de::DeserializeOwned;
use serde::Serialize;
use std::io::Read;
use thiserror::Error;

#[cfg(feature = "serialize_rmp")]
mod serialize_rmp;

#[cfg(feature = "serialize_bincode")]
mod serialize_bincode;

#[cfg(feature = "serialize_postcard")]
mod serialize_postcard;

#[cfg(feature = "serialize_json")]
mod serialize_json;

pub type SerializationResult<T> = std::result::Result<T, SerializationError>;

#[derive(Debug, Error)]
pub enum SerializationError {
    #[cfg(feature = "serialize_rmp")]
    #[error("failed to serialize messagepack payload: {0}")]
    SerializeRmp(#[from] rmp_serde::encode::Error),

    #[cfg(feature = "serialize_rmp")]
    #[error("failed to deserialize messagepack payload: {0}")]
    DeserializeRmp(#[from] rmp_serde::decode::Error),

    #[cfg(feature = "serialize_bincode")]
    #[error("failed to de/serialize bincode payload: {0}")]
    Bincode(#[from] bincode::Error),

    #[cfg(feature = "serialize_postcard")]
    #[error("failed to de/serialize postcard payload: {0}")]
    Postcard(#[from] postcard::Error),

    #[cfg(feature = "serialize_json")]
    #[error("failed to de/serialize json payload: {0}")]
    Json(#[from] serde_json::Error),

    #[error("io error occurred on de/serialization: {0}")]
    Io(#[from] std::io::Error),

    #[error("the format {0:?} is not available")]
    UnavailableFormat(DynamicSerializer),

    #[error("tried to create serializer for unknown format {0}")]
    UnknownFormat(usize),
}

#[derive(Clone, Copy, Debug, Ord, PartialOrd, Eq, PartialEq)]
pub enum DynamicSerializer {
    Messagepack,
    Bincode,
    Postcard,
    Json,
}

impl DynamicSerializer {
    pub fn first_available() -> Self {
        #[cfg(feature = "serialize_rmp")]
        {
            Self::Messagepack
        }

        #[cfg(all(feature = "serialize_bincode", not(feature = "serialize_rmp")))]
        {
            Self::Bincode
        }

        #[cfg(all(
            feature = "serialize_postcard",
            not(any(feature = "serialize_rmp", feature = "serialize_bincode"))
        ))]
        {
            Self::Postcard
        }

        #[cfg(all(
            feature = "serialize_json",
            not(any(
                feature = "serialize_rmp",
                feature = "serialize_bincode",
                feature = "serialize_postcard"
            ))
        ))]
        {
            Self::Json
        }
    }

    #[inline]
    pub fn from_primitive(num: usize) -> SerializationResult<Self> {
        match num {
            #[cfg(feature = "serialize_rmp")]
            0 => Ok(Self::Messagepack),

            #[cfg(feature = "serialize_bincode")]
            1 => Ok(Self::Bincode),

            #[cfg(feature = "serialize_postcard")]
            2 => Ok(Self::Postcard),

            #[cfg(feature = "serialize_json")]
            3 => Ok(Self::Json),

            n => Err(SerializationError::UnknownFormat(n)),
        }
    }

    pub fn serialize<T: Serialize>(&self, data: T) -> SerializationResult<Bytes> {
        match self {
            #[cfg(feature = "serialize_rmp")]
            DynamicSerializer::Messagepack => serialize_rmp::serialize(data),

            #[cfg(feature = "serialize_bincode")]
            DynamicSerializer::Bincode => serialize_bincode::serialize(data),

            #[cfg(feature = "serialize_postcard")]
            DynamicSerializer::Postcard => serialize_postcard::serialize(data),

            #[cfg(feature = "serialize_json")]
            DynamicSerializer::Json => serialize_json::serialize(data),

            #[cfg(not(all(
                feature = "serialize_rmp",
                feature = "serialize_bincode",
                feature = "serialize_postcard",
                feature = "serialize_json"
            )))]
            _ => Err(SerializationError::UnavailableFormat(self.clone())),
        }
    }

    pub fn deserialize<T: DeserializeOwned, R: Read>(&self, reader: R) -> SerializationResult<T> {
        match self {
            #[cfg(feature = "serialize_rmp")]
            DynamicSerializer::Messagepack => serialize_rmp::deserialize(reader),

            #[cfg(feature = "serialize_bincode")]
            DynamicSerializer::Bincode => serialize_bincode::deserialize(reader),

            #[cfg(feature = "serialize_postcard")]
            DynamicSerializer::Postcard => serialize_postcard::deserialize(reader),

            #[cfg(feature = "serialize_json")]
            DynamicSerializer::Json => serialize_json::deserialize(reader),

            #[cfg(not(all(
                feature = "serialize_rmp",
                feature = "serialize_bincode",
                feature = "serialize_postcard",
                feature = "serialize_json"
            )))]
            _ => Err(SerializationError::UnavailableFormat(self.clone())),
        }
    }
}