Skip to main content

nu_json/
value.rs

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