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
//! An [AMF3](http://download.macromedia.com/pub/labs/amf/amf3_spec_121207.pdf) implementation. //! //! # Examples //! ``` //! use amf::amf3::Value; //! //! // Encodes a AMF3's integer //! let integer = Value::from(Value::Integer(123)); //! let mut buf = Vec::new(); //! integer.write_to(&mut buf).unwrap(); //! //! // Decodes above integer //! let decoded = Value::read_from(&mut &buf[..]).unwrap(); //! assert_eq!(integer, decoded); //! ``` use std::io; use std::time; use Pair; use DecodeResult; pub use self::decode::Decoder; pub use self::encode::Encoder; mod decode; mod encode; mod marker { pub const UNDEFINED: u8 = 0x00; pub const NULL: u8 = 0x01; pub const FALSE: u8 = 0x02; pub const TRUE: u8 = 0x03; pub const INTEGER: u8 = 0x04; pub const DOUBLE: u8 = 0x05; pub const STRING: u8 = 0x06; pub const XML_DOC: u8 = 0x07; pub const DATE: u8 = 0x08; pub const ARRAY: u8 = 0x09; pub const OBJECT: u8 = 0x0A; pub const XML: u8 = 0x0B; pub const BYTE_ARRAY: u8 = 0x0C; pub const VECTOR_INT: u8 = 0x0D; pub const VECTOR_UINT: u8 = 0xE; pub const VECTOR_DOUBLE: u8 = 0x0F; pub const VECTOR_OBJECT: u8 = 0x10; pub const DICTIONARY: u8 = 0x11; } /// AMF3 value. /// /// # Examples /// ``` /// use amf::amf3::Value; /// /// // Encodes a AMF3's integer /// let integer = Value::from(Value::Integer(123)); /// let mut buf = Vec::new(); /// integer.write_to(&mut buf).unwrap(); /// /// // Decodes above integer /// let decoded = Value::read_from(&mut &buf[..]).unwrap(); /// assert_eq!(integer, decoded); /// ``` #[derive(Debug, Clone, PartialEq, PartialOrd)] pub enum Value { /// See [3.2 undefined Type] /// (http://download.macromedia.com/pub/labs/amf/amf3_spec_121207.pdf#page=6&zoom=auto,88,264). Undefined, /// See [3.3 null Type] /// (http://download.macromedia.com/pub/labs/amf/amf3_spec_121207.pdf#page=6&zoom=auto,88,139). Null, /// See [3.4 false Type] /// (http://download.macromedia.com/pub/labs/amf/amf3_spec_121207.pdf#page=7&zoom=auto,88,694) /// and /// [3.5 true Type] /// (http://download.macromedia.com/pub/labs/amf/amf3_spec_121207.pdf#page=7&zoom=auto,88,596). Boolean(bool), /// See [3.6 integer Type] /// (http://download.macromedia.com/pub/labs/amf/amf3_spec_121207.pdf#page=7&zoom=auto,88,499). Integer(i32), /// See [3.7 double Type] /// (http://download.macromedia.com/pub/labs/amf/amf3_spec_121207.pdf#page=7&zoom=auto,88,321). Double(f64), /// See [3.8 String Type] /// (http://download.macromedia.com/pub/labs/amf/amf3_spec_121207.pdf#page=7&zoom=auto,88,196). String(String), /// See [3.9 XMLDocument Type] /// (http://download.macromedia.com/pub/labs/amf/amf3_spec_121207.pdf#page=8&zoom=auto,88,639). XmlDocument(String), /// See [3.10 Date Type] /// (http://download.macromedia.com/pub/labs/amf/amf3_spec_121207.pdf#page=8&zoom=auto,88,316). Date { /// Unix timestamp with milliseconds precision. unix_time: time::Duration, }, /// See [3.11 Array Type] /// (http://download.macromedia.com/pub/labs/amf/amf3_spec_121207.pdf#page=9&zoom=auto,88,720). Array { /// Entries of the associative part of the array. assoc_entries: Vec<Pair<String, Value>>, /// Entries of the dense part of the array. dense_entries: Vec<Value>, }, /// See [3.12 Object Type] /// (http://download.macromedia.com/pub/labs/amf/amf3_spec_121207.pdf#page=9&zoom=auto,88,275). Object { /// The class name of the object. /// `None` means it is an anonymous object. class_name: Option<String>, /// Sealed member count of the object. /// /// Sealed members are located in front of the `entries`. sealed_count: usize, /// Members of the object. entries: Vec<Pair<String, Value>>, }, /// See [3.13 XML Type] /// (http://download.macromedia.com/pub/labs/amf/amf3_spec_121207.pdf#page=11&zoom=auto,88,360). Xml(String), /// See [3.14 ByteArray Type] /// (http://download.macromedia.com/pub/labs/amf/amf3_spec_121207.pdf#page=11&zoom=auto,88,167). ByteArray(Vec<u8>), /// See [3.15 Vector Type] /// (http://download.macromedia.com/pub/labs/amf/amf3_spec_121207.pdf#page=12&zoom=auto,88,534). IntVector { /// If `true`, this is a fixed-length vector. is_fixed: bool, /// The entries of the vector. entries: Vec<i32>, }, /// See [3.15 Vector Type] /// (http://download.macromedia.com/pub/labs/amf/amf3_spec_121207.pdf#page=12&zoom=auto,88,534). UintVector { /// If `true`, this is a fixed-length vector. is_fixed: bool, /// The entries of the vector. entries: Vec<u32>, }, /// See [3.15 Vector Type] /// (http://download.macromedia.com/pub/labs/amf/amf3_spec_121207.pdf#page=12&zoom=auto,88,534). DoubleVector { /// If `true`, this is a fixed-length vector. is_fixed: bool, /// The entries of the vector. entries: Vec<f64>, }, /// See [3.15 Vector Type] /// (http://download.macromedia.com/pub/labs/amf/amf3_spec_121207.pdf#page=12&zoom=auto,88,534). ObjectVector { /// The base type name of entries in the vector. /// `None` means it is the ANY type. class_name: Option<String>, /// If `true`, this is a fixed-length vector. is_fixed: bool, /// The entries of the vector. entries: Vec<Value>, }, /// See [3.16 Dictionary Type] /// (http://download.macromedia.com/pub/labs/amf/amf3_spec_121207.pdf#page=13&zoom=auto,88,601). Dictionary { /// If `true`, the keys of `entries` are weakly referenced. is_weak: bool, /// The entries of the dictionary. entries: Vec<Pair<Value, Value>>, }, } impl Value { /// Reads an AMF3 encoded `Value` from `reader`. /// /// Note that reference objects are copied in the decoding phase /// for the sake of simplicity of the resulting value representation. /// And circular reference are unsupported (i.e., those are treated as errors). pub fn read_from<R>(reader: R) -> DecodeResult<Self> where R: io::Read { Decoder::new(reader).decode() } /// Writes the AMF3 encoded bytes of this value to `writer`. pub fn write_to<W>(&self, writer: W) -> io::Result<()> where W: io::Write { Encoder::new(writer).encode(self) } /// Tries to convert the value as a `str` reference. pub fn try_as_str(&self) -> Option<&str> { match *self { Value::String(ref x) => Some(x.as_str()), Value::XmlDocument(ref x) => Some(x.as_str()), Value::Xml(ref x) => Some(x.as_str()), _ => None, } } /// Tries to convert the value as a `f64`. pub fn try_as_f64(&self) -> Option<f64> { match *self { Value::Integer(x) => Some(x as f64), Value::Double(x) => Some(x), _ => None, } } /// Tries to convert the value as an iterator of the contained values. pub fn try_into_values(self) -> Result<Box<Iterator<Item = Value>>, Self> { match self { Value::Array { dense_entries, .. } => Ok(Box::new(dense_entries.into_iter())), Value::IntVector { entries, .. } => { Ok(Box::new(entries.into_iter().map(Value::Integer))) } Value::UintVector { entries, .. } => { Ok(Box::new(entries.into_iter().map(|n| Value::Double(n as f64)))) } Value::DoubleVector { entries, .. } => { Ok(Box::new(entries.into_iter().map(Value::Double))) } Value::ObjectVector { entries, .. } => Ok(Box::new(entries.into_iter())), _ => Err(self), } } /// Tries to convert the value as an iterator of the contained pairs. pub fn try_into_pairs(self) -> Result<Box<Iterator<Item = (String, Value)>>, Self> { match self { Value::Array { assoc_entries, .. } => { Ok(Box::new(assoc_entries.into_iter().map(|p| (p.key, p.value)))) } Value::Object { entries, .. } => { Ok(Box::new(entries.into_iter().map(|p| (p.key, p.value)))) } _ => Err(self), } } }