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
use std::{collections::BTreeMap, convert::TryFrom};
use iso8601::DateTime;
pub mod de;
pub mod ser;
pub use de::Deserializer;
pub use ser::Serializer;
/// Convert a `T` into `serde_xmlrpc::Value` which is an enum that can represent
/// any valid XML-RPC data.
///
/// # Example
///
/// ```
/// #[derive(serde::Serialize)]
/// struct Custom {
/// field: i32,
/// }
///
/// let param = Custom {
/// field: 42
/// };
///
/// let _value = serde_xmlrpc::to_value(param).unwrap();
/// ```
pub fn to_value<T>(value: T) -> crate::Result<Value>
where
T: serde::Serialize,
{
value.serialize(Serializer)
}
/// Represents any single valid xmlrpc "Value"
#[derive(Clone, Debug, PartialEq)]
pub enum Value {
/// A 32-bit signed integer (`<i4>` or `<int>`).
Int(i32),
/// A 64-bit signed integer (`<i8>`).
Int64(i64),
/// A boolean value (`<boolean>`, 0 == `false`, 1 == `true`).
Bool(bool),
/// A string (`<string>`).
String(String),
/// A double-precision IEEE 754 floating point number (`<double>`).
Double(f64),
/// An ISO 8601 formatted date/time value (`<dateTime.iso8601>`).
DateTime(DateTime),
/// Base64-encoded binary data (`<base64>`).
Base64(Vec<u8>),
/// A mapping of named values (`<struct>`).
Struct(BTreeMap<String, Value>),
/// A list of arbitrary (heterogeneous) values (`<array>`).
Array(Vec<Value>),
/// The empty (Unit) value (`<nil/>`).
Nil,
}
// Public API definitions
impl Value {
/// Returns an inner struct or array value indexed by `index`.
///
/// Returns `None` if the member doesn't exist or `self` is neither a struct nor an array.
///
/// You can also use Rust's square-bracket indexing syntax to perform this operation if you want
/// a default value instead of an `Option`. Refer to the top-level [examples](#examples) for
/// details.
/*
pub fn get<I: Index>(&self, index: I) -> Option<&Value> {
index.get(self)
}
*/
/// If the `Value` is a normal integer (`Value::Int`), returns associated value. Returns `None`
/// otherwise.
///
/// In particular, `None` is also returned if `self` is a `Value::Int64`. Use [`as_i64`] to
/// handle this case.
///
/// [`as_i64`]: #method.as_i64
pub fn as_i32(&self) -> Option<i32> {
match *self {
Value::Int(i) => Some(i),
_ => None,
}
}
/// If the `Value` is an integer, returns associated value. Returns `None` otherwise.
///
/// This works with both `Value::Int` and `Value::Int64`.
pub fn as_i64(&self) -> Option<i64> {
match *self {
Value::Int(i) => Some(i64::from(i)),
Value::Int64(i) => Some(i),
_ => None,
}
}
/// If the `Value` is a boolean, returns associated value. Returns `None` otherwise.
pub fn as_bool(&self) -> Option<bool> {
match *self {
Value::Bool(b) => Some(b),
_ => None,
}
}
/// If the `Value` is a string, returns associated value. Returns `None` otherwise.
pub fn as_str(&self) -> Option<&str> {
match *self {
Value::String(ref s) => Some(s),
_ => None,
}
}
/// If the `Value` is a floating point number, returns associated value. Returns `None`
/// otherwise.
pub fn as_f64(&self) -> Option<f64> {
match *self {
Value::Double(d) => Some(d),
_ => None,
}
}
/// If the `Value` is a date/time, returns associated value. Returns `None` otherwise.
pub fn as_datetime(&self) -> Option<DateTime> {
match *self {
Value::DateTime(dt) => Some(dt),
_ => None,
}
}
/// If the `Value` is base64 binary data, returns associated value. Returns `None` otherwise.
pub fn as_bytes(&self) -> Option<&[u8]> {
match *self {
Value::Base64(ref data) => Some(data),
_ => None,
}
}
/// If the `Value` is a struct, returns associated map. Returns `None` otherwise.
pub fn as_struct(&self) -> Option<&BTreeMap<String, Value>> {
match *self {
Value::Struct(ref map) => Some(map),
_ => None,
}
}
/// If the `Value` is an array, returns associated slice. Returns `None` otherwise.
pub fn as_array(&self) -> Option<&[Value]> {
match *self {
Value::Array(ref array) => Some(array),
_ => None,
}
}
}
// Conversions into and from Value
impl From<i32> for Value {
fn from(other: i32) -> Self {
Value::Int(other)
}
}
impl<'a> TryFrom<&'a Value> for i32 {
type Error = ();
fn try_from(value: &'a Value) -> Result<Self, Self::Error> {
match value {
Value::Int(i) => Ok(*i),
_ => Err(()),
}
}
}
impl From<i64> for Value {
fn from(other: i64) -> Self {
Value::Int64(other)
}
}
impl<'a> TryFrom<&'a Value> for &'a i64 {
type Error = ();
fn try_from(value: &'a Value) -> Result<Self, Self::Error> {
match value {
Value::Int64(i) => Ok(i),
_ => Err(()),
}
}
}
impl From<bool> for Value {
fn from(other: bool) -> Self {
Value::Bool(other)
}
}
impl<'a> TryFrom<&'a Value> for &'a bool {
type Error = ();
fn try_from(value: &'a Value) -> Result<Self, Self::Error> {
match value {
Value::Bool(i) => Ok(i),
_ => Err(()),
}
}
}
impl From<String> for Value {
fn from(other: String) -> Self {
Value::String(other)
}
}
impl<'a> TryFrom<&'a Value> for String {
type Error = ();
fn try_from(value: &'a Value) -> Result<Self, Self::Error> {
if let Some(val) = value.as_str() {
Ok(val.to_string())
} else {
Err(())
}
}
}
impl From<&str> for Value {
fn from(other: &str) -> Self {
Value::String(other.to_string())
}
}
impl<'a> TryFrom<&'a Value> for &'a str {
type Error = ();
fn try_from(value: &'a Value) -> Result<Self, Self::Error> {
if let Some(val) = value.as_str() {
Ok(val)
} else {
Err(())
}
}
}
impl From<f64> for Value {
fn from(other: f64) -> Self {
Value::Double(other)
}
}
impl<'a> TryFrom<&'a Value> for &'a f64 {
type Error = ();
fn try_from(value: &'a Value) -> Result<Self, Self::Error> {
match value {
Value::Double(i) => Ok(i),
_ => Err(()),
}
}
}
impl From<DateTime> for Value {
fn from(other: DateTime) -> Self {
Value::DateTime(other)
}
}
impl<'a> TryFrom<&'a Value> for &'a DateTime {
type Error = ();
fn try_from(value: &'a Value) -> Result<Self, Self::Error> {
match value {
Value::DateTime(i) => Ok(i),
_ => Err(()),
}
}
}
impl From<Vec<Value>> for Value {
fn from(other: Vec<Value>) -> Value {
Value::Array(other)
}
}
impl<'a> TryFrom<&'a Value> for &'a Vec<Value> {
type Error = ();
fn try_from(value: &'a Value) -> Result<Self, Self::Error> {
match value {
Value::Array(i) => Ok(i),
_ => Err(()),
}
}
}
impl From<BTreeMap<String, Value>> for Value {
fn from(other: BTreeMap<String, Value>) -> Value {
Value::Struct(other)
}
}
impl<'a> TryFrom<&'a Value> for &'a BTreeMap<String, Value> {
type Error = ();
fn try_from(value: &'a Value) -> Result<Self, Self::Error> {
match value {
Value::Struct(i) => Ok(i),
_ => Err(()),
}
}
}
impl From<Vec<u8>> for Value {
fn from(other: Vec<u8>) -> Self {
Value::Base64(other)
}
}
impl<'a> TryFrom<&'a Value> for &'a Vec<u8> {
type Error = ();
fn try_from(value: &'a Value) -> Result<Self, Self::Error> {
match value {
Value::Base64(i) => Ok(i),
_ => Err(()),
}
}
}