rmp_serde/lib.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 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337
#![doc = include_str!("../README.md")]
#![forbid(unsafe_code)]
#![warn(missing_debug_implementations, missing_docs)]
use std::fmt::{self, Display, Formatter};
use std::str::{self, Utf8Error};
use serde::de;
use serde::{Deserialize, Serialize};
#[allow(deprecated)]
pub use crate::decode::from_read_ref;
pub use crate::decode::{from_read, Deserializer};
pub use crate::encode::{to_vec, to_vec_named, Serializer};
pub use crate::decode::from_slice;
mod bytes;
pub mod config;
pub mod decode;
pub mod encode;
/// Hack used to serialize MessagePack Extension types.
///
/// A special `ExtStruct` type is used to represent
/// extension types. This struct is renamed in serde.
///
/// Name of Serde newtype struct to Represent Msgpack's Ext
/// Msgpack Ext: `Ext(tag, binary)`
/// Serde data model: `_ExtStruct((tag, binary))`
///
/// Example Serde impl for custom type:
///
/// ```ignore
/// #[derive(Debug, PartialEq, Serialize, Deserialize)]
/// #[serde(rename = "_ExtStruct")]
/// struct ExtStruct((i8, serde_bytes::ByteBuf));
///
/// test_round(ExtStruct((2, serde_bytes::ByteBuf::from(vec![5]))),
/// Value::Ext(2, vec![5]));
/// ```
pub const MSGPACK_EXT_STRUCT_NAME: &str = "_ExtStruct";
/// Helper that allows both to encode and decode strings no matter whether they contain valid or
/// invalid UTF-8.
///
/// Regardless of validity the UTF-8 content this type will always be serialized as a string.
#[derive(Clone, Debug, PartialEq)]
#[doc(hidden)]
pub struct Raw {
s: Result<String, (Vec<u8>, Utf8Error)>,
}
impl Raw {
/// Constructs a new `Raw` from the UTF-8 string.
#[inline]
#[must_use]
pub fn new(v: String) -> Self {
Self { s: Ok(v) }
}
/// DO NOT USE. See <https://github.com/3Hren/msgpack-rust/issues/305>
#[deprecated(note = "This feature has been removed")]
#[must_use]
pub fn from_utf8(v: Vec<u8>) -> Self {
match String::from_utf8(v) {
Ok(v) => Raw::new(v),
Err(err) => {
let e = err.utf8_error();
Self {
s: Err((err.into_bytes(), e)),
}
}
}
}
/// Returns `true` if the raw is valid UTF-8.
#[inline]
#[must_use]
pub fn is_str(&self) -> bool {
self.s.is_ok()
}
/// Returns `true` if the raw contains invalid UTF-8 sequence.
#[inline]
#[must_use]
pub fn is_err(&self) -> bool {
self.s.is_err()
}
/// Returns the string reference if the raw is valid UTF-8, or else `None`.
#[inline]
#[must_use]
pub fn as_str(&self) -> Option<&str> {
match self.s {
Ok(ref s) => Some(s.as_str()),
Err(..) => None,
}
}
/// Returns the underlying `Utf8Error` if the raw contains invalid UTF-8 sequence, or
/// else `None`.
#[inline]
#[must_use]
pub fn as_err(&self) -> Option<&Utf8Error> {
match self.s {
Ok(..) => None,
Err((_, ref err)) => Some(err),
}
}
/// Returns a byte slice of this raw's contents.
#[inline]
#[must_use]
pub fn as_bytes(&self) -> &[u8] {
match self.s {
Ok(ref s) => s.as_bytes(),
Err(ref err) => &err.0[..],
}
}
/// Consumes this object, yielding the string if the raw is valid UTF-8, or else `None`.
#[inline]
#[must_use]
pub fn into_str(self) -> Option<String> {
self.s.ok()
}
/// Converts a `Raw` into a byte vector.
#[inline]
#[must_use]
pub fn into_bytes(self) -> Vec<u8> {
match self.s {
Ok(s) => s.into_bytes(),
Err(err) => err.0,
}
}
}
impl Serialize for Raw {
fn serialize<S>(&self, se: S) -> Result<S::Ok, S::Error>
where
S: serde::Serializer,
{
match self.s {
Ok(ref s) => se.serialize_str(s),
Err((ref b, ..)) => se.serialize_bytes(b),
}
}
}
struct RawVisitor;
impl<'de> de::Visitor<'de> for RawVisitor {
type Value = Raw;
#[cold]
fn expecting(&self, fmt: &mut Formatter<'_>) -> Result<(), fmt::Error> {
"string or bytes".fmt(fmt)
}
#[inline]
fn visit_string<E>(self, v: String) -> Result<Self::Value, E> {
Ok(Raw { s: Ok(v) })
}
#[inline]
fn visit_str<E>(self, v: &str) -> Result<Self::Value, E>
where E: de::Error
{
Ok(Raw { s: Ok(v.into()) })
}
#[inline]
fn visit_bytes<E>(self, v: &[u8]) -> Result<Self::Value, E>
where E: de::Error
{
let s = match str::from_utf8(v) {
Ok(s) => Ok(s.into()),
Err(err) => Err((v.into(), err)),
};
Ok(Raw { s })
}
#[inline]
fn visit_byte_buf<E>(self, v: Vec<u8>) -> Result<Self::Value, E>
where E: de::Error
{
let s = match String::from_utf8(v) {
Ok(s) => Ok(s),
Err(err) => {
let e = err.utf8_error();
Err((err.into_bytes(), e))
}
};
Ok(Raw { s })
}
}
impl<'de> Deserialize<'de> for Raw {
#[inline]
fn deserialize<D>(de: D) -> Result<Self, D::Error>
where D: de::Deserializer<'de>
{
de.deserialize_any(RawVisitor)
}
}
/// Helper that allows both to encode and decode strings no matter whether they contain valid or
/// invalid UTF-8.
///
/// Regardless of validity the UTF-8 content this type will always be serialized as a string.
#[derive(Clone, Copy, Debug, PartialEq)]
#[doc(hidden)]
pub struct RawRef<'a> {
s: Result<&'a str, (&'a [u8], Utf8Error)>,
}
impl<'a> RawRef<'a> {
/// Constructs a new `RawRef` from the UTF-8 string.
#[inline]
#[must_use]
pub fn new(v: &'a str) -> Self {
Self { s: Ok(v) }
}
#[deprecated(note = "This feature has been removed")]
#[must_use]
pub fn from_utf8(v: &'a [u8]) -> Self {
match str::from_utf8(v) {
Ok(v) => RawRef::new(v),
Err(err) => {
Self {
s: Err((v, err))
}
}
}
}
/// Returns `true` if the raw is valid UTF-8.
#[inline]
#[must_use]
pub fn is_str(&self) -> bool {
self.s.is_ok()
}
/// Returns `true` if the raw contains invalid UTF-8 sequence.
#[inline]
#[must_use]
pub fn is_err(&self) -> bool {
self.s.is_err()
}
/// Returns the string reference if the raw is valid UTF-8, or else `None`.
#[inline]
#[must_use]
pub fn as_str(&self) -> Option<&str> {
match self.s {
Ok(s) => Some(s),
Err(..) => None,
}
}
/// Returns the underlying `Utf8Error` if the raw contains invalid UTF-8 sequence, or
/// else `None`.
#[inline]
#[must_use]
pub fn as_err(&self) -> Option<&Utf8Error> {
match self.s {
Ok(..) => None,
Err((_, ref err)) => Some(err),
}
}
/// Returns a byte slice of this raw's contents.
#[inline]
#[must_use]
pub fn as_bytes(&self) -> &[u8] {
match self.s {
Ok(s) => s.as_bytes(),
Err((bytes, _err)) => bytes,
}
}
}
impl<'a> Serialize for RawRef<'a> {
fn serialize<S>(&self, se: S) -> Result<S::Ok, S::Error>
where
S: serde::Serializer,
{
match self.s {
Ok(s) => se.serialize_str(s),
Err((b, ..)) => se.serialize_bytes(b),
}
}
}
struct RawRefVisitor;
impl<'de> de::Visitor<'de> for RawRefVisitor {
type Value = RawRef<'de>;
#[cold]
fn expecting(&self, fmt: &mut Formatter<'_>) -> Result<(), fmt::Error> {
"string or bytes".fmt(fmt)
}
#[inline]
fn visit_borrowed_str<E>(self, v: &'de str) -> Result<Self::Value, E>
where E: de::Error
{
Ok(RawRef { s: Ok(v) })
}
#[inline]
fn visit_borrowed_bytes<E>(self, v: &'de [u8]) -> Result<Self::Value, E>
where E: de::Error
{
let s = match str::from_utf8(v) {
Ok(s) => Ok(s),
Err(err) => Err((v, err)),
};
Ok(RawRef { s })
}
}
impl<'de> Deserialize<'de> for RawRef<'de> {
#[inline]
fn deserialize<D>(de: D) -> Result<Self, D::Error>
where D: de::Deserializer<'de>
{
de.deserialize_any(RawRefVisitor)
}
}