rmp_serde/config.rs
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 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245
//! Change MessagePack behavior with configuration wrappers.
/// Represents configuration that dicatates what the serializer does.
///
/// Implemented as an empty trait depending on a hidden trait in order to allow changing the
/// methods of this trait without breaking backwards compatibility.
pub trait SerializerConfig: sealed::SerializerConfig {}
impl<T: sealed::SerializerConfig> SerializerConfig for T {}
pub(crate) mod sealed {
use crate::config::BytesMode;
/// This is the inner trait - the real `SerializerConfig`.
///
/// This hack disallows external implementations and usage of `SerializerConfig` and thus
/// allows us to change `SerializerConfig` methods freely without breaking backwards compatibility.
pub trait SerializerConfig: Copy {
/// Determines the value of `Serializer::is_human_readable` and
/// `Deserializer::is_human_readable`.
fn is_human_readable(&self) -> bool;
/// String struct fields
fn is_named(&self) -> bool;
fn bytes(&self) -> BytesMode;
}
}
#[derive(Copy, Clone, Debug)]
pub(crate) struct RuntimeConfig {
pub(crate) is_human_readable: bool,
pub(crate) is_named: bool,
pub(crate) bytes: BytesMode,
}
/// When to encode `[u8]` as `bytes` rather than a sequence
/// of integers. Serde without `serde_bytes` has trouble
/// using `bytes`, and this is hack to force it. It may
/// break some data types.
#[non_exhaustive]
#[derive(Debug, Copy, Clone, Default, PartialEq, Eq)]
pub enum BytesMode {
/// Use bytes only when Serde requires it
/// (typically only when `serde_bytes` is used)
#[default]
Normal,
/// Use bytes for slices, `Vec`, and a few other types that
/// use `Iterator` in Serde.
///
/// This may break some implementations of `Deserialize`.
///
/// This does not include fixed-length arrays.
ForceIterables,
/// Use bytes for everything that looks like a container of `u8`.
/// This breaks some implementations of `Deserialize`.
ForceAll,
}
impl RuntimeConfig {
pub(crate) fn new(other: impl sealed::SerializerConfig) -> Self {
Self {
is_human_readable: other.is_human_readable(),
is_named: other.is_named(),
bytes: other.bytes(),
}
}
}
impl sealed::SerializerConfig for RuntimeConfig {
#[inline]
fn is_human_readable(&self) -> bool {
self.is_human_readable
}
#[inline]
fn is_named(&self) -> bool {
self.is_named
}
#[inline]
fn bytes(&self) -> BytesMode {
self.bytes
}
}
/// The default serializer/deserializer configuration.
///
/// This configuration:
/// - Writes structs as a tuple, without field names
/// - Writes enum variants as integers
/// - Writes and reads types as binary, not human-readable
//
/// This is the most compact representation.
#[derive(Copy, Clone, Debug)]
pub struct DefaultConfig;
impl sealed::SerializerConfig for DefaultConfig {
#[inline(always)]
fn is_named(&self) -> bool {
false
}
#[inline(always)]
fn is_human_readable(&self) -> bool {
false
}
#[inline(always)]
fn bytes(&self) -> BytesMode {
BytesMode::default()
}
}
/// Config wrapper, that overrides struct serialization by packing as a map with field names.
///
/// MessagePack specification does not tell how to serialize structs. This trait allows you to
/// extend serialization to match your app's requirements.
///
/// Default `Serializer` implementation writes structs as a tuple, i.e. only its length is encoded,
/// because it is the most compact representation.
#[derive(Copy, Clone, Debug)]
pub struct StructMapConfig<C>(C);
impl<C> StructMapConfig<C> {
/// Creates a `StructMapConfig` inheriting unchanged configuration options from the given configuration.
#[inline]
pub fn new(inner: C) -> Self {
StructMapConfig(inner)
}
}
impl<C> sealed::SerializerConfig for StructMapConfig<C>
where
C: sealed::SerializerConfig,
{
#[inline(always)]
fn is_named(&self) -> bool {
true
}
#[inline(always)]
fn is_human_readable(&self) -> bool {
self.0.is_human_readable()
}
fn bytes(&self) -> BytesMode {
self.0.bytes()
}
}
/// Config wrapper that overrides struct serlization by packing as a tuple without field
/// names.
#[derive(Copy, Clone, Debug)]
pub struct StructTupleConfig<C>(C);
impl<C> StructTupleConfig<C> {
/// Creates a `StructTupleConfig` inheriting unchanged configuration options from the given configuration.
#[inline]
pub fn new(inner: C) -> Self {
StructTupleConfig(inner)
}
}
impl<C> sealed::SerializerConfig for StructTupleConfig<C>
where
C: sealed::SerializerConfig,
{
#[inline(always)]
fn is_named(&self) -> bool {
false
}
#[inline(always)]
fn is_human_readable(&self) -> bool {
self.0.is_human_readable()
}
fn bytes(&self) -> BytesMode {
self.0.bytes()
}
}
/// Config wrapper that overrides `Serializer::is_human_readable` and
/// `Deserializer::is_human_readable` to return `true`.
#[derive(Copy, Clone, Debug)]
pub struct HumanReadableConfig<C>(C);
impl<C> HumanReadableConfig<C> {
/// Creates a `HumanReadableConfig` inheriting unchanged configuration options from the given configuration.
#[inline]
pub fn new(inner: C) -> Self {
Self(inner)
}
}
impl<C> sealed::SerializerConfig for HumanReadableConfig<C>
where
C: sealed::SerializerConfig,
{
#[inline(always)]
fn is_named(&self) -> bool {
self.0.is_named()
}
#[inline(always)]
fn is_human_readable(&self) -> bool {
true
}
fn bytes(&self) -> BytesMode {
self.0.bytes()
}
}
/// Config wrapper that overrides `Serializer::is_human_readable` and
/// `Deserializer::is_human_readable` to return `false`.
#[derive(Copy, Clone, Debug)]
pub struct BinaryConfig<C>(C);
impl<C> BinaryConfig<C> {
/// Creates a `BinaryConfig` inheriting unchanged configuration options from the given configuration.
#[inline(always)]
pub fn new(inner: C) -> Self {
Self(inner)
}
}
impl<C> sealed::SerializerConfig for BinaryConfig<C>
where
C: sealed::SerializerConfig,
{
#[inline(always)]
fn is_named(&self) -> bool {
self.0.is_named()
}
#[inline(always)]
fn is_human_readable(&self) -> bool {
false
}
fn bytes(&self) -> BytesMode {
self.0.bytes()
}
}