    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
    437
    438
    439
    440
    441
    442
    443
    444
    445
    446
    447
    448
    449
    450
    451
    452
    453
    454
    455
    456
    457
    458
    459
    460
    461
    462
    463
    464
    465
    466
    467
    468
    469
    470
    471
    472
    473
    474
    475
    476
    477
    478
    479
    480
    481
    482
    483
    484
    485
    486
    487
    488
    489
    490
    491
    492
    493
    494
    495
    496
    497
    498
    499
    500
    501
    502
    503
    504
    505
    506
    507
    508
    509
    510
    511
    512
    513
    514
    515
    516
    517
    518
    519
    520
    521
    522
    523
    524
    525
    526
    527
    528
    529
    530
    531
    532
    533
    534
    535
    536
    537
    538
    539
    540
    541
    542
    543
    544
    545
    546
    547
    548
    549
    550
    551
    552
    553
    554
    555
    556
    557
    558
    559
    560
    561
    562
    563
    564
    565
    566
    567
    568
    569
    570
    571
    572
    573
    574
    575
    576
    577
    578
    579
    580
    581
    582
    583
    584
    585
    586
    587
    588
    589
    590
    591
    592
    593
    594
    595

    // Copyright 2017 Serde Developers
    //
    // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
    // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
    // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
    // option. This file may not be copied, modified, or distributed
    // except according to those terms.

    //! A map of String to toml::Value.
    //!
    //! By default the map is backed by a [`BTreeMap`]. Enable the `preserve_order`
    //! feature of toml-rs to use [`LinkedHashMap`] instead.
    //!
    //! [`BTreeMap`]: https://doc.rust-lang.org/std/collections/struct.BTreeMap.html
    //! [`LinkedHashMap`]: https://docs.rs/linked-hash-map/*/linked_hash_map/struct.LinkedHashMap.html

    use crate::value::Value;
    use serde::{de, ser};
    use std::borrow::Borrow;
    use std::fmt::{self, Debug};
    use std::hash::Hash;
    use std::iter::FromIterator;
    use std::ops;

    #[cfg(not(feature = "preserve_order"))]
    use std::collections::{btree_map, BTreeMap};

    #[cfg(feature = "preserve_order")]
    use indexmap::{self, IndexMap};

    /// Represents a TOML key/value type.
    pub struct Map<K, V> {
        map: MapImpl<K, V>,
    }

    #[cfg(not(feature = "preserve_order"))]
    type MapImpl<K, V> = BTreeMap<K, V>;
    #[cfg(feature = "preserve_order")]
    type MapImpl<K, V> = IndexMap<K, V>;

    impl Map<String, Value> {
        /// Makes a new empty Map.
        #[inline]
        pub fn new() -> Self {
            Map {
                map: MapImpl::new(),
            }
        }

        #[cfg(not(feature = "preserve_order"))]
        /// Makes a new empty Map with the given initial capacity.
        #[inline]
        pub fn with_capacity(capacity: usize) -> Self {
            // does not support with_capacity
            let _ = capacity;
            Map {
                map: BTreeMap::new(),
            }
        }

        #[cfg(feature = "preserve_order")]
        /// Makes a new empty Map with the given initial capacity.
        #[inline]
        pub fn with_capacity(capacity: usize) -> Self {
            Map {
                map: IndexMap::with_capacity(capacity),
            }
        }

        /// Clears the map, removing all values.
        #[inline]
        pub fn clear(&mut self) {
            self.map.clear()
        }

        /// Returns a reference to the value corresponding to the key.
        ///
        /// The key may be any borrowed form of the map's key type, but the ordering
        /// on the borrowed form *must* match the ordering on the key type.
        #[inline]
        pub fn get<Q: ?Sized>(&self, key: &Q) -> Option<&Value>
        where
            String: Borrow<Q>,
            Q: Ord + Eq + Hash,
        {
            self.map.get(key)
        }

        /// Returns true if the map contains a value for the specified key.
        ///
        /// The key may be any borrowed form of the map's key type, but the ordering
        /// on the borrowed form *must* match the ordering on the key type.
        #[inline]
        pub fn contains_key<Q: ?Sized>(&self, key: &Q) -> bool
        where
            String: Borrow<Q>,
            Q: Ord + Eq + Hash,
        {
            self.map.contains_key(key)
        }

        /// Returns a mutable reference to the value corresponding to the key.
        ///
        /// The key may be any borrowed form of the map's key type, but the ordering
        /// on the borrowed form *must* match the ordering on the key type.
        #[inline]
        pub fn get_mut<Q: ?Sized>(&mut self, key: &Q) -> Option<&mut Value>
        where
            String: Borrow<Q>,
            Q: Ord + Eq + Hash,
        {
            self.map.get_mut(key)
        }

        /// Inserts a key-value pair into the map.
        ///
        /// If the map did not have this key present, `None` is returned.
        ///
        /// If the map did have this key present, the value is updated, and the old
        /// value is returned. The key is not updated, though; this matters for
        /// types that can be `==` without being identical.
        #[inline]
        pub fn insert(&mut self, k: String, v: Value) -> Option<Value> {
            self.map.insert(k, v)
        }

        /// Removes a key from the map, returning the value at the key if the key
        /// was previously in the map.
        ///
        /// The key may be any borrowed form of the map's key type, but the ordering
        /// on the borrowed form *must* match the ordering on the key type.
        #[inline]
        pub fn remove<Q: ?Sized>(&mut self, key: &Q) -> Option<Value>
        where
            String: Borrow<Q>,
            Q: Ord + Eq + Hash,
        {
            self.map.remove(key)
        }

        /// Gets the given key's corresponding entry in the map for in-place
        /// manipulation.
        pub fn entry<S>(&mut self, key: S) -> Entry<'_>
        where
            S: Into<String>,
        {
            #[cfg(feature = "preserve_order")]
            use indexmap::map::Entry as EntryImpl;
            #[cfg(not(feature = "preserve_order"))]
            use std::collections::btree_map::Entry as EntryImpl;

            match self.map.entry(key.into()) {
                EntryImpl::Vacant(vacant) => Entry::Vacant(VacantEntry { vacant }),
                EntryImpl::Occupied(occupied) => Entry::Occupied(OccupiedEntry { occupied }),
            }
        }

        /// Returns the number of elements in the map.
        #[inline]
        pub fn len(&self) -> usize {
            self.map.len()
        }

        /// Returns true if the map contains no elements.
        #[inline]
        pub fn is_empty(&self) -> bool {
            self.map.is_empty()
        }

        /// Gets an iterator over the entries of the map.
        #[inline]
        pub fn iter(&self) -> Iter<'_> {
            Iter {
                iter: self.map.iter(),
            }
        }

        /// Gets a mutable iterator over the entries of the map.
        #[inline]
        pub fn iter_mut(&mut self) -> IterMut<'_> {
            IterMut {
                iter: self.map.iter_mut(),
            }
        }

        /// Gets an iterator over the keys of the map.
        #[inline]
        pub fn keys(&self) -> Keys<'_> {
            Keys {
                iter: self.map.keys(),
            }
        }

        /// Gets an iterator over the values of the map.
        #[inline]
        pub fn values(&self) -> Values<'_> {
            Values {
                iter: self.map.values(),
            }
        }
    }

    impl Default for Map<String, Value> {
        #[inline]
        fn default() -> Self {
            Map {
                map: MapImpl::new(),
            }
        }
    }

    impl Clone for Map<String, Value> {
        #[inline]
        fn clone(&self) -> Self {
            Map {
                map: self.map.clone(),
            }
        }
    }

    impl PartialEq for Map<String, Value> {
        #[inline]
        fn eq(&self, other: &Self) -> bool {
            self.map.eq(&other.map)
        }
    }

    /// Access an element of this map. Panics if the given key is not present in the
    /// map.
    impl<'a, Q: ?Sized> ops::Index<&'a Q> for Map<String, Value>
    where
        String: Borrow<Q>,
        Q: Ord + Eq + Hash,
    {
        type Output = Value;

        fn index(&self, index: &Q) -> &Value {
            self.map.index(index)
        }
    }

    /// Mutably access an element of this map. Panics if the given key is not
    /// present in the map.
    impl<'a, Q: ?Sized> ops::IndexMut<&'a Q> for Map<String, Value>
    where
        String: Borrow<Q>,
        Q: Ord + Eq + Hash,
    {
        fn index_mut(&mut self, index: &Q) -> &mut Value {
            self.map.get_mut(index).expect("no entry found for key")
        }
    }

    impl Debug for Map<String, Value> {
        #[inline]
        fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> Result<(), fmt::Error> {
            self.map.fmt(formatter)
        }
    }

    impl ser::Serialize for Map<String, Value> {
        #[inline]
        fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
        where
            S: ser::Serializer,
        {
            use serde::ser::SerializeMap;
            let mut map = serializer.serialize_map(Some(self.len()))?;
            for (k, v) in self {
                map.serialize_key(k)?;
                map.serialize_value(v)?;
            }
            map.end()
        }
    }

    impl<'de> de::Deserialize<'de> for Map<String, Value> {
        #[inline]
        fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
        where
            D: de::Deserializer<'de>,
        {
            struct Visitor;

            impl<'de> de::Visitor<'de> for Visitor {
                type Value = Map<String, Value>;

                fn expecting(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
                    formatter.write_str("a map")
                }

                #[inline]
                fn visit_unit<E>(self) -> Result<Self::Value, E>
                where
                    E: de::Error,
                {
                    Ok(Map::new())
                }

                #[inline]
                fn visit_map<V>(self, mut visitor: V) -> Result<Self::Value, V::Error>
                where
                    V: de::MapAccess<'de>,
                {
                    let mut values = Map::new();

                    while let Some((key, value)) = visitor.next_entry()? {
                        values.insert(key, value);
                    }

                    Ok(values)
                }
            }

            deserializer.deserialize_map(Visitor)
        }
    }

    impl FromIterator<(String, Value)> for Map<String, Value> {
        fn from_iter<T>(iter: T) -> Self
        where
            T: IntoIterator<Item = (String, Value)>,
        {
            Map {
                map: FromIterator::from_iter(iter),
            }
        }
    }

    impl Extend<(String, Value)> for Map<String, Value> {
        fn extend<T>(&mut self, iter: T)
        where
            T: IntoIterator<Item = (String, Value)>,
        {
            self.map.extend(iter);
        }
    }

    macro_rules! delegate_iterator {
        (($name:ident $($generics:tt)*) => $item:ty) => {
            impl $($generics)* Iterator for $name $($generics)* {
                type Item = $item;
                #[inline]
                fn next(&mut self) -> Option<Self::Item> {
                    self.iter.next()
                }
                #[inline]
                fn size_hint(&self) -> (usize, Option<usize>) {
                    self.iter.size_hint()
                }
            }

            impl $($generics)* DoubleEndedIterator for $name $($generics)* {
                #[inline]
                fn next_back(&mut self) -> Option<Self::Item> {
                    self.iter.next_back()
                }
            }

            impl $($generics)* ExactSizeIterator for $name $($generics)* {
                #[inline]
                fn len(&self) -> usize {
                    self.iter.len()
                }
            }
        }
    }

    //////////////////////////////////////////////////////////////////////////////

    /// A view into a single entry in a map, which may either be vacant or occupied.
    /// This enum is constructed from the [`entry`] method on [`Map`].
    ///
    /// [`entry`]: struct.Map.html#method.entry
    /// [`Map`]: struct.Map.html
    pub enum Entry<'a> {
        /// A vacant Entry.
        Vacant(VacantEntry<'a>),
        /// An occupied Entry.
        Occupied(OccupiedEntry<'a>),
    }

    /// A vacant Entry. It is part of the [`Entry`] enum.
    ///
    /// [`Entry`]: enum.Entry.html
    pub struct VacantEntry<'a> {
        vacant: VacantEntryImpl<'a>,
    }

    /// An occupied Entry. It is part of the [`Entry`] enum.
    ///
    /// [`Entry`]: enum.Entry.html
    pub struct OccupiedEntry<'a> {
        occupied: OccupiedEntryImpl<'a>,
    }

    #[cfg(not(feature = "preserve_order"))]
    type VacantEntryImpl<'a> = btree_map::VacantEntry<'a, String, Value>;
    #[cfg(feature = "preserve_order")]
    type VacantEntryImpl<'a> = indexmap::map::VacantEntry<'a, String, Value>;

    #[cfg(not(feature = "preserve_order"))]
    type OccupiedEntryImpl<'a> = btree_map::OccupiedEntry<'a, String, Value>;
    #[cfg(feature = "preserve_order")]
    type OccupiedEntryImpl<'a> = indexmap::map::OccupiedEntry<'a, String, Value>;

    impl<'a> Entry<'a> {
        /// Returns a reference to this entry's key.
        pub fn key(&self) -> &String {
            match *self {
                Entry::Vacant(ref e) => e.key(),
                Entry::Occupied(ref e) => e.key(),
            }
        }

        /// Ensures a value is in the entry by inserting the default if empty, and
        /// returns a mutable reference to the value in the entry.
        pub fn or_insert(self, default: Value) -> &'a mut Value {
            match self {
                Entry::Vacant(entry) => entry.insert(default),
                Entry::Occupied(entry) => entry.into_mut(),
            }
        }

        /// Ensures a value is in the entry by inserting the result of the default
        /// function if empty, and returns a mutable reference to the value in the
        /// entry.
        pub fn or_insert_with<F>(self, default: F) -> &'a mut Value
        where
            F: FnOnce() -> Value,
        {
            match self {
                Entry::Vacant(entry) => entry.insert(default()),
                Entry::Occupied(entry) => entry.into_mut(),
            }
        }
    }

    impl<'a> VacantEntry<'a> {
        /// Gets a reference to the key that would be used when inserting a value
        /// through the VacantEntry.
        #[inline]
        pub fn key(&self) -> &String {
            self.vacant.key()
        }

        /// Sets the value of the entry with the VacantEntry's key, and returns a
        /// mutable reference to it.
        #[inline]
        pub fn insert(self, value: Value) -> &'a mut Value {
            self.vacant.insert(value)
        }
    }

    impl<'a> OccupiedEntry<'a> {
        /// Gets a reference to the key in the entry.
        #[inline]
        pub fn key(&self) -> &String {
            self.occupied.key()
        }

        /// Gets a reference to the value in the entry.
        #[inline]
        pub fn get(&self) -> &Value {
            self.occupied.get()
        }

        /// Gets a mutable reference to the value in the entry.
        #[inline]
        pub fn get_mut(&mut self) -> &mut Value {
            self.occupied.get_mut()
        }

        /// Converts the entry into a mutable reference to its value.
        #[inline]
        pub fn into_mut(self) -> &'a mut Value {
            self.occupied.into_mut()
        }

        /// Sets the value of the entry with the `OccupiedEntry`'s key, and returns
        /// the entry's old value.
        #[inline]
        pub fn insert(&mut self, value: Value) -> Value {
            self.occupied.insert(value)
        }

        /// Takes the value of the entry out of the map, and returns it.
        #[inline]
        pub fn remove(self) -> Value {
            self.occupied.remove()
        }
    }

    //////////////////////////////////////////////////////////////////////////////

    impl<'a> IntoIterator for &'a Map<String, Value> {
        type Item = (&'a String, &'a Value);
        type IntoIter = Iter<'a>;
        #[inline]
        fn into_iter(self) -> Self::IntoIter {
            Iter {
                iter: self.map.iter(),
            }
        }
    }

    /// An iterator over a toml::Map's entries.
    pub struct Iter<'a> {
        iter: IterImpl<'a>,
    }

    #[cfg(not(feature = "preserve_order"))]
    type IterImpl<'a> = btree_map::Iter<'a, String, Value>;
    #[cfg(feature = "preserve_order")]
    type IterImpl<'a> = indexmap::map::Iter<'a, String, Value>;

    delegate_iterator!((Iter<'a>) => (&'a String, &'a Value));

    //////////////////////////////////////////////////////////////////////////////

    impl<'a> IntoIterator for &'a mut Map<String, Value> {
        type Item = (&'a String, &'a mut Value);
        type IntoIter = IterMut<'a>;
        #[inline]
        fn into_iter(self) -> Self::IntoIter {
            IterMut {
                iter: self.map.iter_mut(),
            }
        }
    }

    /// A mutable iterator over a toml::Map's entries.
    pub struct IterMut<'a> {
        iter: IterMutImpl<'a>,
    }

    #[cfg(not(feature = "preserve_order"))]
    type IterMutImpl<'a> = btree_map::IterMut<'a, String, Value>;
    #[cfg(feature = "preserve_order")]
    type IterMutImpl<'a> = indexmap::map::IterMut<'a, String, Value>;

    delegate_iterator!((IterMut<'a>) => (&'a String, &'a mut Value));

    //////////////////////////////////////////////////////////////////////////////

    impl IntoIterator for Map<String, Value> {
        type Item = (String, Value);
        type IntoIter = IntoIter;
        #[inline]
        fn into_iter(self) -> Self::IntoIter {
            IntoIter {
                iter: self.map.into_iter(),
            }
        }
    }

    /// An owning iterator over a toml::Map's entries.
    pub struct IntoIter {
        iter: IntoIterImpl,
    }

    #[cfg(not(feature = "preserve_order"))]
    type IntoIterImpl = btree_map::IntoIter<String, Value>;
    #[cfg(feature = "preserve_order")]
    type IntoIterImpl = indexmap::map::IntoIter<String, Value>;

    delegate_iterator!((IntoIter) => (String, Value));

    //////////////////////////////////////////////////////////////////////////////

    /// An iterator over a toml::Map's keys.
    pub struct Keys<'a> {
        iter: KeysImpl<'a>,
    }

    #[cfg(not(feature = "preserve_order"))]
    type KeysImpl<'a> = btree_map::Keys<'a, String, Value>;
    #[cfg(feature = "preserve_order")]
    type KeysImpl<'a> = indexmap::map::Keys<'a, String, Value>;

    delegate_iterator!((Keys<'a>) => &'a String);

    //////////////////////////////////////////////////////////////////////////////

    /// An iterator over a toml::Map's values.
    pub struct Values<'a> {
        iter: ValuesImpl<'a>,
    }

    #[cfg(not(feature = "preserve_order"))]
    type ValuesImpl<'a> = btree_map::Values<'a, String, Value>;
    #[cfg(feature = "preserve_order")]
    type ValuesImpl<'a> = indexmap::map::Values<'a, String, Value>;

    delegate_iterator!((Values<'a>) => &'a Value);