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

//! Utility module to convert data to types and back by
//! specific formats like: JSON, BSON, TOML, YAML, XML.
//!
//! All types here are lazy and it's necessary to
//! use `Into` and `From` traits to get (convert) the data.

use anyhow::Error;
use thiserror::Error as ThisError;

#[macro_use]
mod macros;

#[cfg(feature = "bincode")]
#[doc(hidden)]
pub mod bincode;

#[cfg(feature = "cbor")]
#[doc(hidden)]
pub mod cbor;

#[doc(hidden)]
pub mod json;

#[doc(hidden)]
#[cfg(feature = "msgpack")]
pub mod msgpack;

#[doc(hidden)]
pub mod nothing;

#[cfg(feature = "toml")]
#[doc(hidden)]
pub mod toml;

#[cfg(feature = "yaml")]
#[doc(hidden)]
pub mod yaml;

#[cfg(feature = "bincode")]
#[doc(inline)]
pub use self::bincode::Bincode;

#[cfg(feature = "cbor")]
#[doc(inline)]
pub use self::cbor::Cbor;

#[doc(inline)]
pub use self::json::Json;

#[cfg(feature = "msgpack")]
#[doc(inline)]
pub use self::msgpack::MsgPack;

#[doc(inline)]
pub use self::nothing::Nothing;

#[cfg(feature = "toml")]
#[doc(inline)]
pub use self::toml::Toml;

#[cfg(feature = "yaml")]
#[doc(inline)]
pub use self::yaml::Yaml;

/// A representation of a value which can be stored and restored as a text.
///
/// Some formats are binary only and can't be serialized to or deserialized
/// from Text.  Attempting to do so will return an Err(FormatError).
pub type Text = Result<String, Error>;

/// A representation of a value which can be stored and restored as a binary.
pub type Binary = Result<Vec<u8>, Error>;

/// A helper which represents a specific format.
#[doc(hidden)]
pub type Format<T> = Result<T, Error>;

/// Represents formatting errors.
#[derive(Debug, ThisError)]
pub enum FormatError {
    /// Received text for a binary format, e.g. someone sending text
    /// on a WebSocket that is using a binary serialization format, like Cbor.
    #[error("received text for a binary format")]
    ReceivedTextForBinary,
    /// Received binary for a text format, e.g. someone sending binary
    /// on a WebSocket that is using a text serialization format, like Json.
    #[error("received binary for a text format")]
    ReceivedBinaryForText,
    /// Trying to encode a binary format as text", e.g., trying to
    /// store a Cbor encoded value in a String.
    #[error("trying to encode a binary format as Text")]
    CantEncodeBinaryAsText,
}