clonelet 0.2.0

A simple macro to capture by clone in closures
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
146
147
148
149
150
151
152
153
154
155
156
157

/// Clone all the identifiers supplied as arguments.
///
/// `clone!(x, y, z);` will generate:
///
/// ```
/// # #[macro_use] extern crate clonelet;
/// # let (x, y, z) = (0, 0, 0);
/// let x = x.clone();
/// let y = y.clone();
/// let z = z.clone();
/// ```
///
/// This is useful for capturing variables by copy in closures. For example:
///
/// ```
/// # #[macro_use] extern crate clonelet;
/// # let (x, y, z) = (0, 0, 0);
/// let closure = {
///     clone!(x, y, z);
///     move || {}
/// };
/// ```
///
/// If you need a mutable clone, `clone!(mut x)` will generate:
///
/// ```
/// # #[macro_use] extern crate clonelet;
/// # let x = 0;
/// let mut x = x.clone();
/// ```
///
/// You can also clone struct members:
///
/// ```
/// # #[macro_use] extern crate clonelet;
/// struct MyStruct {
///     x: i32
/// }
///
/// impl MyStruct {
///     fn clone_x(&self) {
///         // This will generate `let x = self.x.clone();`
///         clone!(self.x);
///     }
/// }
/// ```
#[macro_export]
macro_rules! clone{
    ($(,)?) => {};
    ($scope:ident . $name:ident $(, $($tail:tt)*)?) => {
        let $name = $scope . $name.clone();
        $($crate::clone!($($tail)*);)?
    };
    (mut $scope:ident . $name:ident $(, $($tail:tt)*)?) => {
        let mut $name = $scope . $name.clone();
        $($crate::clone!($($tail)*);)?
    };
    ($name:ident $(, $($tail:tt)*)?) => {
        let $name = $name.clone();
        $($crate::clone!($($tail)*);)?
    };
    (mut $name:ident $(, $($tail:tt)*)?) => {
        let mut $name = $name.clone();
        $($crate::clone!($($tail)*);)?
    };
}

#[cfg(test)]
mod tests {
    use std::mem;

    #[derive(Clone)]
    struct Test;

    impl Drop for Test {
        fn drop(&mut self) {}
    }

    impl Test {
        fn mutate(&mut self) {}
    }

    struct Scope {
        y: Test,
    }

    impl Scope {
        fn clone_member(&self) {
            clone!(self.y);
            mem::drop(y);
        }
    }

    #[test]
    fn basic() {
        let x = Test;

        {
            clone!(x);
            mem::drop(x);
        }

        mem::drop(x);
    }

    #[test]
    fn mutate() {
        let x = Test;

        {
            clone!(mut x);
            x.mutate();
        }
    }

    #[test]
    fn multi() {
        let x = Test;
        let y = Test;

        {
            clone!(x, mut y);
            y.mutate();
            mem::drop(x);
            mem::drop(y);
        }

        mem::drop(x);
        mem::drop(y);
    }

    #[test]
    fn scope() {
        let x = Scope { y: Test };

        {
            clone!(x.y);
            mem::drop(y);
        }

        mem::drop(x);
    }

    #[test]
    fn mutable_scope() {
        let x = Scope { y: Test };
        x.clone_member();

        {
            clone!(mut x.y);
            y.mutate();
            mem::drop(y);
        }

        mem::drop(x);
    }
}