map 1.3.0

This crate provides the `map!` macro and `map_insert!` macro, to create a HashMap collection and insert key-value pairs. Inspired by the `vec!` macro.
Documentation 
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

/// Use an existing map collection and insert key-value pairs.
///
/// Example with tuple syntax:
///
/// ```
/// # use ::map::*;
/// # use ::std::collections::HashMap;
/// let mut m = HashMap::new();
/// map_insert!(m, (1, 2), (3, 4));
/// ```
///
/// Example with arrow syntax:
///
/// ```
/// # use ::map::*;
/// # use ::std::collections::HashMap;
/// let mut m = HashMap::new();
/// map_insert!(m, 1 => 2, 3 => 4);
/// ```
///
/// Equivalent Rust std code with method `insert`:
///
/// ```
/// # use std::collections::HashMap;
/// let mut m = HashMap::new();
/// m.insert(1, 2);
/// m.insert(3, 4);
/// ```
///
#[allow(unused_macros)]
#[macro_export]
macro_rules! map_insert {
    ($map:ident, $(( $k:expr, $v:expr )),* $(,)?) => {
        {
            $(
                $map.insert($k, $v);
            )*
        }
    };
    ($map:ident, $( $k:expr => $v:expr ),* $(,)?) => {
        {
            $(
                $map.insert($k, $v);
            )*
        }
    };
}

#[cfg(test)]
mod test {

    mod tuple_syntax {

        mod one_line {
            use std::collections::HashMap;

            #[test]
            fn trailing_comma() {
                let mut x = ::std::collections::HashMap::new();
                map_insert!(x, (1, 2), (3, 4),);
                assert_eq!(x, HashMap::from([(1, 2), (3, 4)]));
            }

            #[test]
            fn no_trailing_comma() {
                let mut x = ::std::collections::HashMap::new();
                map_insert!(x, (1, 2), (3, 4));
                assert_eq!(x, HashMap::from([(1, 2), (3, 4)]));
            }
        }

        mod multiple_lines {
            use std::collections::HashMap;

            #[test]
            fn trailing_comma() {
                let mut x = ::std::collections::HashMap::new();
                map_insert!(
                    x,
                    (1, 2),
                    (3, 4),
                );
                assert_eq!(x, HashMap::from([(1, 2), (3, 4)]));
            }

            #[test]
            fn no_trailing_comma() {
                let mut x: std::collections::HashMap<i32, i32> = ::std::collections::HashMap::new();
                map_insert!(
                    x,
                    (1, 2),
                    (3, 4)
                );
                assert_eq!(x, HashMap::from([(1, 2), (3, 4)]));
            }
        }
    }

    mod arrow_syntax {

        mod one_line {
            use std::collections::HashMap;

            #[test]
            fn trailing_comma() {
                let mut x: HashMap<i32, i32> = ::std::collections::HashMap::new();
                map_insert!(x, 1 => 2, 3 => 4,);
                assert_eq!(x, HashMap::from([(1, 2), (3, 4)]));
            }

            #[test]
            fn no_trailing_comma() {
                let mut x: HashMap<i32, i32> = ::std::collections::HashMap::new();
                map_insert!(x, 1 => 2, 3 => 4);
                assert_eq!(x, HashMap::from([(1, 2), (3, 4)]));
            }
        }

        mod multiple_lines {
            use std::collections::HashMap;

            #[test]
            fn trailing_comma() {
                let mut x: HashMap<i32, i32> = ::std::collections::HashMap::new();
                map_insert!(
                    x,
                    1 => 2,
                    3 => 4,
                );
                assert_eq!(x, HashMap::from([(1, 2), (3, 4)]));
            }

            #[test]
            fn no_trailing_comma() {
                let mut x: HashMap<i32, i32> = ::std::collections::HashMap::new();
                map_insert!(
                    x,
                    1 => 2,
                    3 => 4
                );
                assert_eq!(x, HashMap::from([(1, 2), (3, 4)]));
            }
        }
    }
}