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 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436
//! Contains the different types of values understood by XML-RPC. use utils::{escape_xml, format_datetime}; use base64::encode; use iso8601::DateTime; use std::collections::BTreeMap; use std::io::{self, Write}; /// The possible XML-RPC values. /// /// Nested values can be accessed by using [`get`](#method.get) method and Rust's square-bracket /// indexing operator. /// /// A string index can be used to access a value in a `Struct`, and a `usize` index can be used to /// access an element of an `Array`. /// /// # Examples /// /// ``` /// # use xmlrpc::{Value}; /// let nothing = Value::Nil; /// /// let person = Value::Struct(vec![ /// ("name".to_string(), Value::from("John Doe")), /// ("age".to_string(), Value::from(37)), /// ("children".to_string(), Value::Array(vec![ /// Value::from("Mark"), /// Value::from("Jennyfer") /// ])), /// ].into_iter().collect()); /// /// // get /// assert_eq!(nothing.get("name"), None); /// assert_eq!(person.get("name"), Some(&Value::from("John Doe"))); /// assert_eq!(person.get("SSN"), None); /// /// // index /// assert_eq!(nothing["name"], Value::Nil); /// assert_eq!(person["name"], Value::from("John Doe")); /// assert_eq!(person["age"], Value::Int(37)); /// assert_eq!(person["SSN"], Value::Nil); /// assert_eq!(person["children"][0], Value::from("Mark")); /// assert_eq!(person["children"][0]["age"], Value::Nil); /// assert_eq!(person["children"][2], Value::Nil); /// /// // extract values /// assert_eq!(person["name"].as_str(), Some("John Doe")); /// assert_eq!(person["age"].as_i32(), Some(37)); /// assert_eq!(person["age"].as_bool(), None); /// assert_eq!(person["children"].as_array().unwrap().len(), 2); /// ``` #[derive(Clone, Debug, PartialEq)] pub enum Value { /// A 32-bit signed integer (`<i4>` or `<int>`). Int(i32), /// A 64-bit signed integer (`<i8>`). /// /// This is an XMLRPC extension and may not be supported by all clients / servers. Int64(i64), /// A boolean value (`<boolean>`, 0 == `false`, 1 == `true`). Bool(bool), /// A string (`<string>`). // FIXME zero-copy? `Cow<'static, ..>`? String(String), /// A double-precision IEEE 754 floating point number (`<double>`). Double(f64), /// An ISO 8601 formatted date/time value (`<dateTime.iso8601>`). /// /// Note that ISO 8601 is highly ambiguous and allows incomplete date-time specifications. For /// example, servers will frequently leave out timezone information, in which case the client /// must *know* which timezone is used by the server. For this reason, the contained `DateTime` /// struct only contains the raw fields specified by the server, without any real date/time /// functionality like what's offered by the `chrono` crate. /// /// To make matters worse, some clients [don't seem to support][wp-bug] time zone information in /// datetime values. To ensure compatiblity, the xmlrpc crate will try to format datetime values /// like the example given in the [specification] if the timezone offset is zero. /// /// Recommendation: Avoid `DateTime` if possible. A date and time can be specified more /// precisely by formatting it using RFC 3339 and putting it in a [`String`]. /// /// [wp-bug]: https://core.trac.wordpress.org/ticket/1633#comment:4 /// [specification]: http://xmlrpc.scripting.com/spec.html /// [`String`]: #variant.String 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/>`). /// /// This is an XMLRPC [extension][ext] and may not be supported by all clients / servers. /// /// [ext]: https://web.archive.org/web/20050911054235/http://ontosys.com/xml-rpc/extensions.php Nil, } impl Value { /// Formats this `Value` as an XML `<value>` element. /// /// # Errors /// /// Any error reported by the writer will be propagated to the caller. pub fn write_as_xml<W: Write>(&self, fmt: &mut W) -> io::Result<()> { write!(fmt, "<value>")?; match *self { Value::Int(i) => { write!(fmt, "<i4>{}</i4>", i)?; } Value::Int64(i) => { write!(fmt, "<i8>{}</i8>", i)?; } Value::Bool(b) => { write!(fmt, "<boolean>{}</boolean>", if b { "1" } else { "0" })?; } Value::String(ref s) => { write!(fmt, "<string>{}</string>", escape_xml(s))?; } Value::Double(d) => { write!(fmt, "<double>{}</double>", d)?; } Value::DateTime(date_time) => { write!( fmt, "<dateTime.iso8601>{}</dateTime.iso8601>", format_datetime(&date_time) )?; } Value::Base64(ref data) => { write!(fmt, "<base64>{}</base64>", encode(data))?; } Value::Struct(ref map) => { writeln!(fmt, "<struct>")?; for (ref name, ref value) in map { writeln!(fmt, "<member>")?; writeln!(fmt, "<name>{}</name>", escape_xml(name))?; value.write_as_xml(fmt)?; writeln!(fmt, "</member>")?; } write!(fmt, "</struct>")?; } Value::Array(ref array) => { write!(fmt, "<array>")?; writeln!(fmt, "<data>")?; for value in array { value.write_as_xml(fmt)?; } write!(fmt, "</data>")?; write!(fmt, "</array>")?; } Value::Nil => { write!(fmt, "<nil/>")?; } } writeln!(fmt, "</value>")?; Ok(()) } /// 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, } } } impl From<i32> for Value { fn from(other: i32) -> Self { Value::Int(other) } } impl From<i64> for Value { fn from(other: i64) -> Self { Value::Int64(other) } } impl From<bool> for Value { fn from(other: bool) -> Self { Value::Bool(other) } } impl From<String> for Value { fn from(other: String) -> Self { Value::String(other) } } impl<'a> From<&'a str> for Value { fn from(other: &'a str) -> Self { Value::String(other.to_string()) } } impl From<f64> for Value { fn from(other: f64) -> Self { Value::Double(other) } } impl From<DateTime> for Value { fn from(other: DateTime) -> Self { Value::DateTime(other) } } impl From<Vec<u8>> for Value { fn from(other: Vec<u8>) -> Self { Value::Base64(other) } } mod sealed { /// A trait that is only nameable (and thus implementable) inside this crate. pub trait Sealed {} impl Sealed for str {} impl Sealed for String {} impl Sealed for usize {} impl<'a, I> Sealed for &'a I where I: Sealed + ?Sized {} } /// A type that can be used to index into a [`Value`]. /// /// You can use Rust's regular indexing syntax to access components of [`Value`]s. Refer to the /// examples on [`Value`] for details. /// /// This trait can not be implemented by custom types. /// /// [`Value`]: enum.Value.html pub trait Index: sealed::Sealed { /// Gets an inner value of a given value represented by self. #[doc(hidden)] fn get<'v>(&self, value: &'v Value) -> Option<&'v Value>; } impl Index for str { fn get<'v>(&self, value: &'v Value) -> Option<&'v Value> { if let Value::Struct(ref map) = *value { map.get(self) } else { None } } } impl Index for String { fn get<'v>(&self, value: &'v Value) -> Option<&'v Value> { if let Value::Struct(ref map) = *value { map.get(self) } else { None } } } impl Index for usize { fn get<'v>(&self, value: &'v Value) -> Option<&'v Value> { if let Value::Array(ref array) = *value { array.get(*self) } else { None } } } impl<'a, I> Index for &'a I where I: Index + ?Sized, { fn get<'v>(&self, value: &'v Value) -> Option<&'v Value> { (*self).get(value) } } impl<I> ::std::ops::Index<I> for Value where I: Index, { type Output = Value; fn index(&self, index: I) -> &Self::Output { index.get(self).unwrap_or(&Value::Nil) } } #[cfg(test)] mod tests { use super::*; use std::collections::BTreeMap; use std::str; #[test] fn escapes_strings() { let mut output: Vec<u8> = Vec::new(); Value::from("<xml> string") .write_as_xml(&mut output) .unwrap(); assert_eq!( str::from_utf8(&output).unwrap(), "<value><string><xml>&nbsp;string</string></value>\n" ); } #[test] fn escapes_struct_member_names() { let mut output: Vec<u8> = Vec::new(); let mut map: BTreeMap<String, Value> = BTreeMap::new(); map.insert("x&<x".to_string(), Value::from(true)); Value::Struct(map).write_as_xml(&mut output).unwrap(); assert_eq!(str::from_utf8(&output).unwrap(), "<value><struct>\n<member>\n<name>x&<x</name>\n<value><boolean>1</boolean></value>\n</member>\n</struct></value>\n"); } #[test] fn access_nested_values() { let mut map: BTreeMap<String, Value> = BTreeMap::new(); map.insert("name".to_string(), Value::from("John Doe")); map.insert("age".to_string(), Value::from(37)); map.insert( "children".to_string(), Value::Array(vec![Value::from("Mark"), Value::from("Jennyfer")]), ); let value = Value::Struct(map); assert_eq!(value.get("name"), Some(&Value::from("John Doe"))); assert_eq!(value.get("age"), Some(&Value::from(37))); assert_eq!(value.get("birthdate"), None); assert_eq!(Value::Nil.get("age"), None); assert_eq!(value["name"], Value::from("John Doe")); assert_eq!(value["age"], Value::from(37)); assert_eq!(value["birthdate"], Value::Nil); assert_eq!(Value::Nil["age"], Value::Nil); assert_eq!(value["children"][0], Value::from("Mark")); assert_eq!(value["children"][1], Value::from("Jennyfer")); assert_eq!(value["children"][2], Value::Nil); assert_eq!(value["age"].as_i32(), Some(37)); assert_eq!(value["children"][0].as_str(), Some("Mark")); } }