nu_json/
value.rs

1#[cfg(not(feature = "preserve_order"))]
2use std::collections::{btree_map, BTreeMap};
3
4#[cfg(feature = "preserve_order")]
5use linked_hash_map::LinkedHashMap;
6
7use std::fmt;
8use std::io;
9use std::str;
10use std::vec;
11
12use num_traits::NumCast;
13
14use serde::de;
15use serde::ser;
16
17use crate::error::{Error, ErrorCode};
18
19type Result<T, E = Error> = std::result::Result<T, E>;
20
21/// Represents a key/value type.
22#[cfg(not(feature = "preserve_order"))]
23pub type Map<K, V> = BTreeMap<K, V>;
24/// Represents a key/value type.
25#[cfg(feature = "preserve_order")]
26pub type Map<K, V> = LinkedHashMap<K, V>;
27
28/// Represents the `IntoIter` type.
29#[cfg(not(feature = "preserve_order"))]
30pub type MapIntoIter<K, V> = btree_map::IntoIter<K, V>;
31/// Represents the IntoIter type.
32#[cfg(feature = "preserve_order")]
33pub type MapIntoIter<K, V> = linked_hash_map::IntoIter<K, V>;
34
35fn map_with_capacity<K: std::hash::Hash + Eq, V>(size: Option<usize>) -> Map<K, V> {
36    #[cfg(not(feature = "preserve_order"))]
37    {
38        let _ = size;
39        BTreeMap::new()
40    }
41
42    #[cfg(feature = "preserve_order")]
43    {
44        LinkedHashMap::with_capacity(size.unwrap_or(0))
45    }
46}
47
48/// Represents a Hjson/JSON value
49#[derive(Clone, PartialEq)]
50pub enum Value {
51    /// Represents a JSON null value
52    Null,
53
54    /// Represents a JSON Boolean
55    Bool(bool),
56
57    /// Represents a JSON signed integer
58    I64(i64),
59
60    /// Represents a JSON unsigned integer
61    U64(u64),
62
63    /// Represents a JSON floating point number
64    F64(f64),
65
66    /// Represents a JSON string
67    String(String),
68
69    /// Represents a JSON array
70    Array(Vec<Value>),
71
72    /// Represents a JSON object
73    Object(Map<String, Value>),
74}
75
76impl Value {
77    /// If the `Value` is an Object, returns the value associated with the provided key.
78    /// Otherwise, returns None.
79    pub fn find<'a>(&'a self, key: &str) -> Option<&'a Value> {
80        match *self {
81            Value::Object(ref map) => map.get(key),
82            _ => None,
83        }
84    }
85
86    /// Attempts to get a nested Value Object for each key in `keys`.
87    /// If any key is found not to exist, find_path will return None.
88    /// Otherwise, it will return the `Value` associated with the final key.
89    pub fn find_path<'a>(&'a self, keys: &[&str]) -> Option<&'a Value> {
90        let mut target = self;
91        for key in keys {
92            match target.find(key) {
93                Some(t) => {
94                    target = t;
95                }
96                None => return None,
97            }
98        }
99        Some(target)
100    }
101
102    /// Looks up a value by a JSON Pointer.
103    ///
104    /// JSON Pointer defines a string syntax for identifying a specific value
105    /// within a JavaScript Object Notation (JSON) document.
106    ///
107    /// A Pointer is a Unicode string with the reference tokens separated by `/`.
108    /// Inside tokens `/` is replaced by `~1` and `~` is replaced by `~0`. The
109    /// addressed value is returned and if there is no such value `None` is
110    /// returned.
111    ///
112    /// For more information read [RFC6901](https://tools.ietf.org/html/rfc6901).
113    pub fn pointer<'a>(&'a self, pointer: &str) -> Option<&'a Value> {
114        fn parse_index(s: &str) -> Option<usize> {
115            if s.starts_with('+') || (s.starts_with('0') && s.len() != 1) {
116                return None;
117            }
118            s.parse().ok()
119        }
120        if pointer.is_empty() {
121            return Some(self);
122        }
123        if !pointer.starts_with('/') {
124            return None;
125        }
126        let mut target = self;
127        for escaped_token in pointer.split('/').skip(1) {
128            let token = escaped_token.replace("~1", "/").replace("~0", "~");
129            let target_opt = match *target {
130                Value::Object(ref map) => map.get(&token[..]),
131                Value::Array(ref list) => parse_index(&token[..]).and_then(|x| list.get(x)),
132                _ => return None,
133            };
134            if let Some(t) = target_opt {
135                target = t;
136            } else {
137                return None;
138            }
139        }
140        Some(target)
141    }
142
143    /// If the `Value` is an Object, performs a depth-first search until
144    /// a value associated with the provided key is found. If no value is found
145    /// or the `Value` is not an Object, returns None.
146    pub fn search<'a>(&'a self, key: &str) -> Option<&'a Value> {
147        match self {
148            Value::Object(map) => map
149                .get(key)
150                .or_else(|| map.values().find_map(|v| v.search(key))),
151            _ => None,
152        }
153    }
154
155    /// Returns true if the `Value` is an Object. Returns false otherwise.
156    pub fn is_object(&self) -> bool {
157        self.as_object().is_some()
158    }
159
160    /// If the `Value` is an Object, returns the associated Map.
161    /// Returns None otherwise.
162    pub fn as_object(&self) -> Option<&Map<String, Value>> {
163        match *self {
164            Value::Object(ref map) => Some(map),
165            _ => None,
166        }
167    }
168
169    /// If the `Value` is an Object, returns the associated mutable Map.
170    /// Returns None otherwise.
171    pub fn as_object_mut(&mut self) -> Option<&mut Map<String, Value>> {
172        match *self {
173            Value::Object(ref mut map) => Some(map),
174            _ => None,
175        }
176    }
177
178    /// Returns true if the `Value` is an Array. Returns false otherwise.
179    pub fn is_array(&self) -> bool {
180        self.as_array().is_some()
181    }
182
183    /// If the `Value` is an Array, returns the associated vector.
184    /// Returns None otherwise.
185    pub fn as_array(&self) -> Option<&[Value]> {
186        match self {
187            Value::Array(array) => Some(array),
188            _ => None,
189        }
190    }
191
192    /// If the `Value` is an Array, returns the associated mutable vector.
193    /// Returns None otherwise.
194    pub fn as_array_mut(&mut self) -> Option<&mut Vec<Value>> {
195        match self {
196            Value::Array(list) => Some(list),
197            _ => None,
198        }
199    }
200
201    /// Returns true if the `Value` is a String. Returns false otherwise.
202    pub fn is_string(&self) -> bool {
203        self.as_str().is_some()
204    }
205
206    /// If the `Value` is a String, returns the associated str.
207    /// Returns None otherwise.
208    pub fn as_str(&self) -> Option<&str> {
209        match self {
210            Value::String(s) => Some(s),
211            _ => None,
212        }
213    }
214
215    /// Returns true if the `Value` is a Number. Returns false otherwise.
216    pub fn is_number(&self) -> bool {
217        matches!(self, Value::I64(_) | Value::U64(_) | Value::F64(_))
218    }
219
220    /// Returns true if the `Value` is a i64. Returns false otherwise.
221    pub fn is_i64(&self) -> bool {
222        matches!(self, Value::I64(_))
223    }
224
225    /// Returns true if the `Value` is a u64. Returns false otherwise.
226    pub fn is_u64(&self) -> bool {
227        matches!(self, Value::U64(_))
228    }
229
230    /// Returns true if the `Value` is a f64. Returns false otherwise.
231    pub fn is_f64(&self) -> bool {
232        matches!(self, Value::F64(_))
233    }
234
235    /// If the `Value` is a number, return or cast it to a i64.
236    /// Returns None otherwise.
237    pub fn as_i64(&self) -> Option<i64> {
238        match *self {
239            Value::I64(n) => Some(n),
240            Value::U64(n) => NumCast::from(n),
241            _ => None,
242        }
243    }
244
245    /// If the `Value` is a number, return or cast it to a u64.
246    /// Returns None otherwise.
247    pub fn as_u64(&self) -> Option<u64> {
248        match *self {
249            Value::I64(n) => NumCast::from(n),
250            Value::U64(n) => Some(n),
251            _ => None,
252        }
253    }
254
255    /// If the `Value` is a number, return or cast it to a f64.
256    /// Returns None otherwise.
257    pub fn as_f64(&self) -> Option<f64> {
258        match *self {
259            Value::I64(n) => NumCast::from(n),
260            Value::U64(n) => NumCast::from(n),
261            Value::F64(n) => Some(n),
262            _ => None,
263        }
264    }
265
266    /// Returns true if the `Value` is a Boolean. Returns false otherwise.
267    pub fn is_boolean(&self) -> bool {
268        self.as_bool().is_some()
269    }
270
271    /// If the `Value` is a Boolean, returns the associated bool.
272    /// Returns None otherwise.
273    pub fn as_bool(&self) -> Option<bool> {
274        match *self {
275            Value::Bool(b) => Some(b),
276            _ => None,
277        }
278    }
279
280    /// Returns true if the `Value` is a Null. Returns false otherwise.
281    pub fn is_null(&self) -> bool {
282        self.as_null().is_some()
283    }
284
285    /// If the `Value` is a Null, returns ().
286    /// Returns None otherwise.
287    pub fn as_null(&self) -> Option<()> {
288        match self {
289            Value::Null => Some(()),
290            _ => None,
291        }
292    }
293
294    fn as_unexpected(&self) -> de::Unexpected<'_> {
295        match *self {
296            Value::Null => de::Unexpected::Unit,
297            Value::Bool(v) => de::Unexpected::Bool(v),
298            Value::I64(v) => de::Unexpected::Signed(v),
299            Value::U64(v) => de::Unexpected::Unsigned(v),
300            Value::F64(v) => de::Unexpected::Float(v),
301            Value::String(ref v) => de::Unexpected::Str(v),
302            Value::Array(_) => de::Unexpected::Seq,
303            Value::Object(_) => de::Unexpected::Map,
304        }
305    }
306}
307
308impl ser::Serialize for Value {
309    #[inline]
310    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
311    where
312        S: ser::Serializer,
313    {
314        match *self {
315            Value::Null => serializer.serialize_unit(),
316            Value::Bool(v) => serializer.serialize_bool(v),
317            Value::I64(v) => serializer.serialize_i64(v),
318            Value::U64(v) => serializer.serialize_u64(v),
319            Value::F64(v) => serializer.serialize_f64(v),
320            Value::String(ref v) => serializer.serialize_str(v),
321            Value::Array(ref v) => v.serialize(serializer),
322            Value::Object(ref v) => v.serialize(serializer),
323        }
324    }
325}
326
327impl<'de> de::Deserialize<'de> for Value {
328    #[inline]
329    fn deserialize<D>(deserializer: D) -> Result<Value, D::Error>
330    where
331        D: de::Deserializer<'de>,
332    {
333        struct ValueVisitor;
334
335        impl<'de> de::Visitor<'de> for ValueVisitor {
336            type Value = Value;
337
338            fn expecting(&self, f: &mut fmt::Formatter) -> fmt::Result {
339                f.write_str("a json value")
340            }
341
342            #[inline]
343            fn visit_bool<E>(self, value: bool) -> Result<Value, E> {
344                Ok(Value::Bool(value))
345            }
346
347            #[inline]
348            fn visit_i64<E>(self, value: i64) -> Result<Value, E> {
349                if value < 0 {
350                    Ok(Value::I64(value))
351                } else {
352                    Ok(Value::U64(value as u64))
353                }
354            }
355
356            #[inline]
357            fn visit_u64<E>(self, value: u64) -> Result<Value, E> {
358                Ok(Value::U64(value))
359            }
360
361            #[inline]
362            fn visit_f64<E>(self, value: f64) -> Result<Value, E> {
363                Ok(Value::F64(value))
364            }
365
366            #[inline]
367            fn visit_str<E>(self, value: &str) -> Result<Value, E>
368            where
369                E: de::Error,
370            {
371                self.visit_string(String::from(value))
372            }
373
374            #[inline]
375            fn visit_string<E>(self, value: String) -> Result<Value, E> {
376                Ok(Value::String(value))
377            }
378
379            #[inline]
380            fn visit_none<E>(self) -> Result<Value, E> {
381                Ok(Value::Null)
382            }
383
384            #[inline]
385            fn visit_some<D>(self, deserializer: D) -> Result<Value, D::Error>
386            where
387                D: de::Deserializer<'de>,
388            {
389                de::Deserialize::deserialize(deserializer)
390            }
391
392            #[inline]
393            fn visit_unit<E>(self) -> Result<Value, E> {
394                Ok(Value::Null)
395            }
396
397            #[inline]
398            fn visit_seq<A>(self, mut seq: A) -> Result<Value, A::Error>
399            where
400                A: de::SeqAccess<'de>,
401            {
402                let mut v = match seq.size_hint() {
403                    Some(cap) => Vec::with_capacity(cap),
404                    None => Vec::new(),
405                };
406
407                while let Some(el) = seq.next_element()? {
408                    v.push(el)
409                }
410
411                Ok(Value::Array(v))
412            }
413
414            #[inline]
415            fn visit_map<A>(self, mut map: A) -> Result<Value, A::Error>
416            where
417                A: de::MapAccess<'de>,
418            {
419                let mut values = map_with_capacity(map.size_hint());
420                while let Some((k, v)) = map.next_entry()? {
421                    values.insert(k, v);
422                }
423                Ok(Value::Object(values))
424            }
425        }
426
427        deserializer.deserialize_any(ValueVisitor)
428    }
429}
430
431struct WriterFormatter<'a, 'b: 'a> {
432    inner: &'a mut fmt::Formatter<'b>,
433}
434
435impl io::Write for WriterFormatter<'_, '_> {
436    fn write(&mut self, buf: &[u8]) -> io::Result<usize> {
437        fn io_error<E>(_: E) -> io::Error {
438            // Value does not matter because fmt::Debug and fmt::Display impls
439            // below just map it to fmt::Error
440            io::Error::new(io::ErrorKind::Other, "fmt error")
441        }
442        let s = str::from_utf8(buf).map_err(io_error)?;
443        self.inner.write_str(s).map_err(io_error)?;
444        Ok(buf.len())
445    }
446
447    fn flush(&mut self) -> io::Result<()> {
448        Ok(())
449    }
450}
451
452impl fmt::Debug for Value {
453    /// Serializes a Hjson value into a string
454    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
455        let mut wr = WriterFormatter { inner: f };
456        super::ser::to_writer(&mut wr, self).map_err(|_| fmt::Error)
457    }
458}
459
460impl fmt::Display for Value {
461    /// Serializes a Hjson value into a string
462    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
463        let mut wr = WriterFormatter { inner: f };
464        super::ser::to_writer(&mut wr, self).map_err(|_| fmt::Error)
465    }
466}
467
468impl str::FromStr for Value {
469    type Err = Error;
470    fn from_str(s: &str) -> Result<Value> {
471        super::de::from_str(s)
472    }
473}
474
475/// Create a `serde::Serializer` that serializes a `Serialize`e into a `Value`.
476#[derive(Default)]
477pub struct Serializer;
478
479impl ser::Serializer for Serializer {
480    type Ok = Value;
481    type Error = Error;
482
483    type SerializeSeq = SerializeVec;
484    type SerializeTuple = SerializeVec;
485    type SerializeTupleStruct = SerializeVec;
486    type SerializeTupleVariant = SerializeTupleVariant;
487    type SerializeMap = SerializeMap;
488    type SerializeStruct = SerializeMap;
489    type SerializeStructVariant = SerializeStructVariant;
490
491    #[inline]
492    fn serialize_bool(self, value: bool) -> Result<Value> {
493        Ok(Value::Bool(value))
494    }
495
496    #[inline]
497    fn serialize_i8(self, value: i8) -> Result<Value> {
498        self.serialize_i64(value as i64)
499    }
500
501    #[inline]
502    fn serialize_i16(self, value: i16) -> Result<Value> {
503        self.serialize_i64(value as i64)
504    }
505
506    #[inline]
507    fn serialize_i32(self, value: i32) -> Result<Value> {
508        self.serialize_i64(value as i64)
509    }
510
511    fn serialize_i64(self, value: i64) -> Result<Value> {
512        let v = if value < 0 {
513            Value::I64(value)
514        } else {
515            Value::U64(value as u64)
516        };
517        Ok(v)
518    }
519
520    #[inline]
521    fn serialize_u8(self, value: u8) -> Result<Value> {
522        self.serialize_u64(value as u64)
523    }
524
525    #[inline]
526    fn serialize_u16(self, value: u16) -> Result<Value> {
527        self.serialize_u64(value as u64)
528    }
529
530    #[inline]
531    fn serialize_u32(self, value: u32) -> Result<Value> {
532        self.serialize_u64(value as u64)
533    }
534
535    #[inline]
536    fn serialize_u64(self, value: u64) -> Result<Value> {
537        Ok(Value::U64(value))
538    }
539
540    #[inline]
541    fn serialize_f32(self, value: f32) -> Result<Value> {
542        self.serialize_f64(value as f64)
543    }
544
545    #[inline]
546    fn serialize_f64(self, value: f64) -> Result<Value> {
547        Ok(Value::F64(value))
548    }
549
550    #[inline]
551    fn serialize_char(self, value: char) -> Result<Value> {
552        let mut s = String::new();
553        s.push(value);
554        self.serialize_str(&s)
555    }
556
557    #[inline]
558    fn serialize_str(self, value: &str) -> Result<Value> {
559        Ok(Value::String(String::from(value)))
560    }
561
562    fn serialize_bytes(self, value: &[u8]) -> Result<Value> {
563        let mut state = self.serialize_seq(Some(value.len()))?;
564        for byte in value {
565            ser::SerializeSeq::serialize_element(&mut state, byte)?;
566        }
567        ser::SerializeSeq::end(state)
568    }
569
570    #[inline]
571    fn serialize_unit(self) -> Result<Value> {
572        Ok(Value::Null)
573    }
574
575    #[inline]
576    fn serialize_unit_struct(self, _name: &'static str) -> Result<Value> {
577        self.serialize_unit()
578    }
579
580    #[inline]
581    fn serialize_unit_variant(
582        self,
583        _name: &'static str,
584        _variant_index: u32,
585        variant: &'static str,
586    ) -> Result<Value> {
587        self.serialize_str(variant)
588    }
589
590    #[inline]
591    fn serialize_newtype_struct<T>(self, _name: &'static str, value: &T) -> Result<Value>
592    where
593        T: ?Sized + ser::Serialize,
594    {
595        value.serialize(self)
596    }
597
598    fn serialize_newtype_variant<T>(
599        self,
600        _name: &'static str,
601        _variant_index: u32,
602        variant: &'static str,
603        value: &T,
604    ) -> Result<Value>
605    where
606        T: ?Sized + ser::Serialize,
607    {
608        let mut values = Map::new();
609        values.insert(String::from(variant), to_value(&value)?);
610        Ok(Value::Object(values))
611    }
612
613    #[inline]
614    fn serialize_none(self) -> Result<Value> {
615        self.serialize_unit()
616    }
617
618    #[inline]
619    fn serialize_some<V>(self, value: &V) -> Result<Value>
620    where
621        V: ?Sized + ser::Serialize,
622    {
623        value.serialize(self)
624    }
625
626    #[inline]
627    fn serialize_seq(self, len: Option<usize>) -> Result<Self::SerializeSeq, Self::Error> {
628        Ok(SerializeVec {
629            vec: Vec::with_capacity(len.unwrap_or(0)),
630        })
631    }
632
633    #[inline]
634    fn serialize_tuple(self, len: usize) -> Result<Self::SerializeTuple, Self::Error> {
635        self.serialize_seq(Some(len))
636    }
637
638    #[inline]
639    fn serialize_tuple_struct(
640        self,
641        _name: &'static str,
642        len: usize,
643    ) -> Result<Self::SerializeTupleStruct, Self::Error> {
644        self.serialize_seq(Some(len))
645    }
646
647    #[inline]
648    fn serialize_tuple_variant(
649        self,
650        _name: &'static str,
651        _variant_index: u32,
652        variant: &'static str,
653        len: usize,
654    ) -> Result<Self::SerializeTupleVariant, Self::Error> {
655        Ok(SerializeTupleVariant {
656            name: variant,
657            vec: Vec::with_capacity(len),
658        })
659    }
660
661    #[inline]
662    fn serialize_map(self, len: Option<usize>) -> Result<Self::SerializeMap, Self::Error> {
663        Ok(SerializeMap {
664            map: map_with_capacity(len),
665            next_key: None,
666        })
667    }
668
669    #[inline]
670    fn serialize_struct(
671        self,
672        _name: &'static str,
673        len: usize,
674    ) -> Result<Self::SerializeStruct, Self::Error> {
675        self.serialize_map(Some(len))
676    }
677
678    #[inline]
679    fn serialize_struct_variant(
680        self,
681        _name: &'static str,
682        _variant_index: u32,
683        variant: &'static str,
684        len: usize,
685    ) -> Result<Self::SerializeStructVariant, Self::Error> {
686        Ok(SerializeStructVariant {
687            name: variant,
688            map: map_with_capacity(Some(len)),
689        })
690    }
691}
692
693#[doc(hidden)]
694pub struct SerializeVec {
695    vec: Vec<Value>,
696}
697
698#[doc(hidden)]
699pub struct SerializeTupleVariant {
700    name: &'static str,
701    vec: Vec<Value>,
702}
703
704#[doc(hidden)]
705pub struct SerializeMap {
706    map: Map<String, Value>,
707    next_key: Option<String>,
708}
709
710#[doc(hidden)]
711pub struct SerializeStructVariant {
712    name: &'static str,
713    map: Map<String, Value>,
714}
715
716impl ser::SerializeSeq for SerializeVec {
717    type Ok = Value;
718    type Error = Error;
719
720    fn serialize_element<T>(&mut self, value: &T) -> Result<()>
721    where
722        T: ?Sized + ser::Serialize,
723    {
724        self.vec.push(to_value(&value)?);
725        Ok(())
726    }
727
728    fn end(self) -> Result<Value> {
729        Ok(Value::Array(self.vec))
730    }
731}
732
733impl ser::SerializeTuple for SerializeVec {
734    type Ok = Value;
735    type Error = Error;
736
737    fn serialize_element<T>(&mut self, value: &T) -> Result<()>
738    where
739        T: ?Sized + ser::Serialize,
740    {
741        ser::SerializeSeq::serialize_element(self, value)
742    }
743
744    fn end(self) -> Result<Value> {
745        ser::SerializeSeq::end(self)
746    }
747}
748
749impl ser::SerializeTupleStruct for SerializeVec {
750    type Ok = Value;
751    type Error = Error;
752
753    fn serialize_field<T>(&mut self, value: &T) -> Result<()>
754    where
755        T: ?Sized + ser::Serialize,
756    {
757        ser::SerializeSeq::serialize_element(self, value)
758    }
759
760    fn end(self) -> Result<Value> {
761        ser::SerializeSeq::end(self)
762    }
763}
764
765impl ser::SerializeTupleVariant for SerializeTupleVariant {
766    type Ok = Value;
767    type Error = Error;
768
769    fn serialize_field<T>(&mut self, value: &T) -> Result<()>
770    where
771        T: ?Sized + ser::Serialize,
772    {
773        self.vec.push(to_value(&value)?);
774        Ok(())
775    }
776
777    fn end(self) -> Result<Value> {
778        let mut object = Map::new();
779
780        object.insert(self.name.to_owned(), Value::Array(self.vec));
781
782        Ok(Value::Object(object))
783    }
784}
785
786impl ser::SerializeMap for SerializeMap {
787    type Ok = Value;
788    type Error = Error;
789
790    fn serialize_key<T>(&mut self, key: &T) -> Result<()>
791    where
792        T: ?Sized + ser::Serialize,
793    {
794        match to_value(key)? {
795            Value::String(s) => self.next_key = Some(s),
796            _ => return Err(Error::Syntax(ErrorCode::KeyMustBeAString, 0, 0)),
797        };
798        Ok(())
799    }
800
801    fn serialize_value<T>(&mut self, value: &T) -> Result<()>
802    where
803        T: ?Sized + ser::Serialize,
804    {
805        let key = self.next_key.take();
806        // Panic because this indicates a bug in the program rather than an
807        // expected failure.
808        let key = key.expect("serialize_value called before serialize_key");
809        self.map.insert(key, to_value(value)?);
810        Ok(())
811    }
812
813    fn end(self) -> Result<Value> {
814        Ok(Value::Object(self.map))
815    }
816}
817
818impl ser::SerializeStruct for SerializeMap {
819    type Ok = Value;
820    type Error = Error;
821
822    fn serialize_field<T>(&mut self, key: &'static str, value: &T) -> Result<()>
823    where
824        T: ?Sized + ser::Serialize,
825    {
826        ser::SerializeMap::serialize_entry(self, key, value)
827    }
828
829    fn end(self) -> Result<Value> {
830        ser::SerializeMap::end(self)
831    }
832}
833
834impl ser::SerializeStructVariant for SerializeStructVariant {
835    type Ok = Value;
836    type Error = Error;
837
838    fn serialize_field<T>(&mut self, key: &'static str, value: &T) -> Result<()>
839    where
840        T: ?Sized + ser::Serialize,
841    {
842        self.map.insert(key.to_owned(), to_value(&value)?);
843        Ok(())
844    }
845
846    fn end(self) -> Result<Value> {
847        let mut object = map_with_capacity(Some(1));
848
849        object.insert(self.name.to_owned(), Value::Object(self.map));
850
851        Ok(Value::Object(object))
852    }
853}
854
855impl<'de> de::Deserializer<'de> for Value {
856    type Error = Error;
857
858    #[inline]
859    fn deserialize_any<V>(self, visitor: V) -> Result<V::Value>
860    where
861        V: de::Visitor<'de>,
862    {
863        match self {
864            Value::Null => visitor.visit_unit(),
865            Value::Bool(v) => visitor.visit_bool(v),
866            Value::I64(v) => visitor.visit_i64(v),
867            Value::U64(v) => visitor.visit_u64(v),
868            Value::F64(v) => visitor.visit_f64(v),
869            Value::String(v) => visitor.visit_string(v),
870            Value::Array(v) => visitor.visit_seq(SeqDeserializer {
871                iter: v.into_iter(),
872            }),
873            Value::Object(v) => visitor.visit_map(MapDeserializer {
874                iter: v.into_iter(),
875                value: None,
876            }),
877        }
878    }
879
880    #[inline]
881    fn deserialize_option<V>(self, visitor: V) -> Result<V::Value>
882    where
883        V: de::Visitor<'de>,
884    {
885        match self {
886            Value::Null => visitor.visit_none(),
887            _ => visitor.visit_some(self),
888        }
889    }
890
891    #[inline]
892    fn deserialize_enum<V>(
893        self,
894        _name: &str,
895        _variants: &'static [&'static str],
896        visitor: V,
897    ) -> Result<V::Value>
898    where
899        V: de::Visitor<'de>,
900    {
901        let (variant, value) = match self {
902            Value::Object(value) => {
903                let mut iter = value.into_iter();
904                let (variant, value) = match iter.next() {
905                    Some(v) => v,
906                    None => {
907                        return Err(de::Error::invalid_type(
908                            de::Unexpected::Map,
909                            &"map with a single key",
910                        ));
911                    }
912                };
913                // enums are encoded in json as maps with a single key:value pair
914                if iter.next().is_some() {
915                    return Err(de::Error::invalid_type(
916                        de::Unexpected::Map,
917                        &"map with a single key",
918                    ));
919                }
920                (variant, Some(value))
921            }
922            Value::String(variant) => (variant, None),
923            val => {
924                return Err(de::Error::invalid_type(
925                    val.as_unexpected(),
926                    &"string or map",
927                ))
928            }
929        };
930
931        visitor.visit_enum(EnumDeserializer { variant, value })
932    }
933
934    #[inline]
935    fn deserialize_newtype_struct<V>(
936        self,
937        _name: &'static str,
938        visitor: V,
939    ) -> Result<V::Value, Self::Error>
940    where
941        V: de::Visitor<'de>,
942    {
943        visitor.visit_newtype_struct(self)
944    }
945
946    serde::forward_to_deserialize_any! {
947        bool i8 i16 i32 i64 i128 u8 u16 u32 u64 u128 f32 f64 char str string
948        bytes byte_buf unit unit_struct seq tuple
949        tuple_struct map struct identifier ignored_any
950    }
951}
952
953struct EnumDeserializer {
954    variant: String,
955    value: Option<Value>,
956}
957
958impl<'de> de::EnumAccess<'de> for EnumDeserializer {
959    type Error = Error;
960
961    type Variant = VariantDeserializer;
962
963    fn variant_seed<V>(self, seed: V) -> Result<(V::Value, Self::Variant), Self::Error>
964    where
965        V: de::DeserializeSeed<'de>,
966    {
967        let variant = de::IntoDeserializer::into_deserializer(self.variant);
968        let visitor = VariantDeserializer { val: self.value };
969        seed.deserialize(variant).map(|v| (v, visitor))
970    }
971}
972
973struct VariantDeserializer {
974    val: Option<Value>,
975}
976
977impl<'de> de::VariantAccess<'de> for VariantDeserializer {
978    type Error = Error;
979
980    fn unit_variant(self) -> Result<()> {
981        match self.val {
982            Some(val) => de::Deserialize::deserialize(val),
983            None => Ok(()),
984        }
985    }
986
987    fn newtype_variant_seed<T>(self, seed: T) -> Result<T::Value>
988    where
989        T: de::DeserializeSeed<'de>,
990    {
991        match self.val {
992            Some(value) => seed.deserialize(value),
993            None => Err(serde::de::Error::invalid_type(
994                de::Unexpected::UnitVariant,
995                &"newtype variant",
996            )),
997        }
998    }
999
1000    fn tuple_variant<V>(self, _len: usize, visitor: V) -> Result<V::Value>
1001    where
1002        V: de::Visitor<'de>,
1003    {
1004        let val = self.val.expect("val is missing");
1005        if let Value::Array(fields) = val {
1006            visitor.visit_seq(SeqDeserializer {
1007                iter: fields.into_iter(),
1008            })
1009        } else {
1010            Err(de::Error::invalid_type(val.as_unexpected(), &visitor))
1011        }
1012    }
1013
1014    fn struct_variant<V>(self, _fields: &'static [&'static str], visitor: V) -> Result<V::Value>
1015    where
1016        V: de::Visitor<'de>,
1017    {
1018        match self.val {
1019            Some(Value::Object(fields)) => visitor.visit_map(MapDeserializer {
1020                iter: fields.into_iter(),
1021                value: None,
1022            }),
1023            Some(other) => Err(de::Error::invalid_type(
1024                other.as_unexpected(),
1025                &"struct variant",
1026            )),
1027            None => Err(de::Error::invalid_type(
1028                de::Unexpected::UnitVariant,
1029                &"struct variant",
1030            )),
1031        }
1032    }
1033}
1034
1035struct SeqDeserializer {
1036    iter: vec::IntoIter<Value>,
1037}
1038
1039impl<'de> de::SeqAccess<'de> for SeqDeserializer {
1040    type Error = Error;
1041
1042    fn next_element_seed<T>(&mut self, seed: T) -> Result<Option<T::Value>, Self::Error>
1043    where
1044        T: de::DeserializeSeed<'de>,
1045    {
1046        match self.iter.next() {
1047            Some(value) => Ok(Some(seed.deserialize(value)?)),
1048            None => Ok(None),
1049        }
1050    }
1051
1052    fn size_hint(&self) -> Option<usize> {
1053        match self.iter.size_hint() {
1054            (lower, Some(upper)) if lower == upper => Some(upper),
1055            _ => None,
1056        }
1057    }
1058}
1059
1060struct MapDeserializer {
1061    iter: MapIntoIter<String, Value>,
1062    value: Option<Value>,
1063}
1064
1065impl<'de> de::MapAccess<'de> for MapDeserializer {
1066    type Error = Error;
1067
1068    fn next_key_seed<K>(&mut self, seed: K) -> Result<Option<K::Value>>
1069    where
1070        K: de::DeserializeSeed<'de>,
1071    {
1072        match self.iter.next() {
1073            Some((key, value)) => {
1074                self.value = Some(value);
1075                Ok(Some(seed.deserialize(Value::String(key))?))
1076            }
1077            None => Ok(None),
1078        }
1079    }
1080
1081    fn next_value_seed<V>(&mut self, seed: V) -> Result<V::Value, Self::Error>
1082    where
1083        V: de::DeserializeSeed<'de>,
1084    {
1085        let value = self.value.take().expect("value is missing");
1086        seed.deserialize(value)
1087    }
1088
1089    fn size_hint(&self) -> Option<usize> {
1090        match self.iter.size_hint() {
1091            (lower, Some(upper)) if lower == upper => Some(upper),
1092            _ => None,
1093        }
1094    }
1095}
1096
1097pub fn to_value<T>(value: &T) -> Result<Value>
1098where
1099    T: ser::Serialize + ?Sized,
1100{
1101    value.serialize(Serializer)
1102}
1103
1104/// Shortcut function to decode a Hjson `Value` into a `T`
1105pub fn from_value<T>(value: Value) -> Result<T>
1106where
1107    T: de::DeserializeOwned,
1108{
1109    de::Deserialize::deserialize(value)
1110}
1111
1112/// A trait for converting values to Hjson
1113pub trait ToJson {
1114    /// Converts the value of `self` to an instance of Hjson
1115    fn to_json(&self) -> Value;
1116}
1117
1118impl<T: ?Sized> ToJson for T
1119where
1120    T: ser::Serialize,
1121{
1122    fn to_json(&self) -> Value {
1123        to_value(&self).expect("failed to serialize")
1124    }
1125}
1126
1127#[cfg(test)]
1128mod test {
1129    use super::Value;
1130    use crate::de::from_str;
1131
1132    #[test]
1133    fn number_deserialize() {
1134        let v: Value = from_str("{\"a\":1}").unwrap();
1135        let vo = v.as_object().unwrap();
1136        assert_eq!(vo["a"].as_u64().unwrap(), 1);
1137
1138        let v: Value = from_str("{\"a\":-1}").unwrap();
1139        let vo = v.as_object().unwrap();
1140        assert_eq!(vo["a"].as_i64().unwrap(), -1);
1141
1142        let v: Value = from_str("{\"a\":1.1}").unwrap();
1143        let vo = v.as_object().unwrap();
1144        assert!((vo["a"].as_f64().unwrap() - 1.1).abs() < f64::EPSILON);
1145
1146        let v: Value = from_str("{\"a\":-1.1}").unwrap();
1147        let vo = v.as_object().unwrap();
1148        assert!((vo["a"].as_f64().unwrap() + 1.1).abs() < f64::EPSILON);
1149
1150        let v: Value = from_str("{\"a\":1e6}").unwrap();
1151        let vo = v.as_object().unwrap();
1152        assert!((vo["a"].as_f64().unwrap() - 1e6).abs() < f64::EPSILON);
1153
1154        let v: Value = from_str("{\"a\":-1e6}").unwrap();
1155        let vo = v.as_object().unwrap();
1156        assert!((vo["a"].as_f64().unwrap() + 1e6).abs() < f64::EPSILON);
1157    }
1158}