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

// Copyright Materialize, Inc. and contributors. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License in the LICENSE file at the
// root of this repository, or online at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

//! Collection utilities.

use std::collections::btree_map::Entry as BEntry;
use std::collections::hash_map::Entry as HEntry;
use std::collections::BTreeMap;
use std::fmt::{Debug, Display};

mod hash;

pub use crate::collections::hash::{HashMap, HashSet};

/// Extension methods for collections.
pub trait CollectionExt<T>: Sized
where
    T: IntoIterator,
{
    /// Consumes the collection and returns its first element.
    ///
    /// This method panics if the collection does not have at least one element.
    fn into_first(self) -> T::Item;

    /// Consumes the collection and returns its last element.
    ///
    /// This method panics if the collection does not have at least one element.
    fn into_last(self) -> T::Item;

    /// Consumes the collection and returns its only element.
    ///
    /// This method panics if the collection does not have exactly one element.
    fn into_element(self) -> T::Item {
        self.expect_element(|| "into_element called on collection without exactly one element")
    }

    /// Consumes the collection and returns its only element.
    ///
    /// This method panics with the given error function's return value if the collection does not
    /// have exactly one element.
    fn expect_element<Err: Display>(self, msg_fn: impl FnOnce() -> Err) -> T::Item;
}

impl<T> CollectionExt<T> for T
where
    T: IntoIterator,
{
    fn into_first(self) -> T::Item {
        self.into_iter().next().unwrap()
    }

    fn into_last(self) -> T::Item {
        self.into_iter().last().unwrap()
    }

    fn expect_element<Err: Display>(self, msg_fn: impl FnOnce() -> Err) -> T::Item {
        let mut iter = self.into_iter();
        match (iter.next(), iter.next()) {
            (Some(el), None) => el,
            _ => panic!("{}", msg_fn()),
        }
    }
}

/// Extension methods for associative collections.
pub trait AssociativeExt<K, V> {
    /// Inserts a key and value, panicking with
    /// a given message if a true
    /// insert (as opposed to an update) cannot be done
    /// because the key already existed in the collection.
    fn expect_insert(&mut self, k: K, v: V, msg: &str);
    /// Inserts a key and value, panicking if a true
    /// insert (as opposed to an update) cannot be done
    /// because the key already existed in the collection.
    fn unwrap_insert(&mut self, k: K, v: V) {
        self.expect_insert(k, v, "called `unwrap_insert` for an already-existing key")
    }

    /// Removes a key, panicking with
    /// a given message if a true
    /// removal (as opposed to a no-op) cannot be done
    /// because the key does not exist in the collection.
    fn expect_remove(&mut self, k: &K, msg: &str) -> V;
    /// Removes a key, panicking if a true
    /// removal (as opposed to a no-op) cannot be done
    /// because the key does not exist in the collection.
    fn unwrap_remove(&mut self, k: &K) -> V {
        self.expect_remove(k, "called `unwrap_remove` for a non-existing key")
    }
}

impl<K, V> AssociativeExt<K, V> for HashMap<K, V>
where
    K: Eq + std::hash::Hash + Debug,
    V: Debug,
{
    fn expect_insert(&mut self, k: K, v: V, msg: &str) {
        match self.entry(k) {
            HEntry::Vacant(e) => {
                e.insert(v);
            }
            HEntry::Occupied(e) => {
                panic!(
                    "{} (key: {:?}, old value: {:?}, new value: {:?})",
                    msg,
                    e.key(),
                    e.get(),
                    v
                )
            }
        }
    }

    fn expect_remove(&mut self, k: &K, msg: &str) -> V {
        match self.remove(k) {
            Some(v) => v,
            None => panic!("{} (key: {:?})", msg, k),
        }
    }
}

impl<K, V> AssociativeExt<K, V> for BTreeMap<K, V>
where
    K: Ord + Debug,
    V: Debug,
{
    fn expect_insert(&mut self, k: K, v: V, msg: &str) {
        match self.entry(k) {
            BEntry::Vacant(e) => {
                e.insert(v);
            }
            BEntry::Occupied(e) => {
                panic!(
                    "{} (key: {:?}, old value: {:?}, new value: {:?})",
                    msg,
                    e.key(),
                    e.get(),
                    v
                )
            }
        }
    }

    fn expect_remove(&mut self, k: &K, msg: &str) -> V {
        match self.remove(k) {
            Some(v) => v,
            None => panic!("{} (key: {:?})", msg, k),
        }
    }
}