darling 0.23.0

A proc-macro library for reading attributes into structs when implementing custom derives.
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
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
use darling::{Error, FromMeta};
use syn::parse_quote;

#[derive(Debug, FromMeta)]
#[darling(derive_syn_parse)]
struct Meta {
    #[darling(default)]
    meta1: Option<String>,
    #[darling(default)]
    meta2: bool,
}

#[test]
fn nested_meta_meta_value() {
    let meta = Meta::from_list(&[parse_quote! {
        meta1 = "thefeature"
    }])
    .unwrap();
    assert_eq!(meta.meta1, Some("thefeature".to_string()));
    assert!(!meta.meta2);
}

#[test]
fn nested_meta_meta_bool() {
    let meta = Meta::from_list(&[parse_quote! {
        meta2
    }])
    .unwrap();
    assert_eq!(meta.meta1, None);
    assert!(meta.meta2);
}

#[test]
fn nested_meta_lit_string_errors() {
    let err = Meta::from_list(&[parse_quote! {
        "meta2"
    }])
    .unwrap_err();
    assert_eq!(
        err.to_string(),
        Error::unsupported_format("literal").to_string()
    );
}

#[test]
fn nested_meta_lit_integer_errors() {
    let err = Meta::from_list(&[parse_quote! {
        2
    }])
    .unwrap_err();
    assert_eq!(
        err.to_string(),
        Error::unsupported_format("literal").to_string()
    );
}

#[test]
fn nested_meta_lit_bool_errors() {
    let err = Meta::from_list(&[parse_quote! {
        true
    }])
    .unwrap_err();
    assert_eq!(
        err.to_string(),
        Error::unsupported_format("literal").to_string()
    );
}

#[test]
fn parse_impl() {
    let meta = parse_quote! {
        meta1 = "thefeature",
        meta2
    };
    let parsed_meta: Meta = syn::parse2(meta).unwrap();
    assert_eq!(parsed_meta.meta1, Some("thefeature".to_string()));
    assert!(parsed_meta.meta2);
}

/// Tests behavior of FromMeta implementation for enums.
mod enum_impl {
    use darling::{Error, FromMeta};
    use syn::parse_quote;

    /// A playback volume.
    #[derive(Debug, Clone, Copy, PartialEq, Eq, FromMeta)]
    enum Volume {
        Normal,
        Low,
        High,
        #[darling(rename = "dB")]
        Decibels(u8),
    }

    #[test]
    fn string_for_unit_variant() {
        let volume = Volume::from_string("low").unwrap();
        assert_eq!(volume, Volume::Low);
    }

    #[test]
    fn single_value_list() {
        let unit_variant = Volume::from_list(&[parse_quote!(high)]).unwrap();
        assert_eq!(unit_variant, Volume::High);

        let newtype_variant = Volume::from_list(&[parse_quote!(dB = 100)]).unwrap();
        assert_eq!(newtype_variant, Volume::Decibels(100));
    }

    #[test]
    fn empty_list_errors() {
        let err = Volume::from_list(&[]).unwrap_err();
        assert_eq!(err.to_string(), Error::too_few_items(1).to_string());
    }

    #[test]
    fn multiple_values_list_errors() {
        let err = Volume::from_list(&[parse_quote!(low), parse_quote!(dB = 20)]).unwrap_err();
        assert_eq!(err.to_string(), Error::too_many_items(1).to_string());
    }
}

mod keyword {
    use darling::FromMeta;
    use quote::quote;
    use syn::{parse2, parse_quote, Path, Type};

    #[derive(Debug, FromMeta)]
    struct Keyword {
        #[darling(rename = "type")]
        ty: Type,
        #[darling(rename = "fn")]
        func: Path,
    }

    #[derive(Debug, FromMeta)]
    struct FlattenKeyword {
        #[darling(rename = "ref")]
        reference: Type,
        #[darling(flatten)]
        keyword: Keyword,
    }

    #[derive(Debug, PartialEq, Eq, FromMeta)]
    enum UnitEnumKeyword {
        #[darling(rename = "enum")]
        Enum,
        #[darling(rename = "struct")]
        Struct,
        #[darling(rename = "trait")]
        Trait,
    }

    #[derive(Debug, FromMeta)]
    struct FlattenEnumKeyword {
        #[darling(rename = "ref")]
        reference: Type,
        #[darling(flatten)]
        keyword: UnitEnumKeyword,
    }

    #[test]
    fn keywords() {
        let meta = quote! {
            outer(type = "u32", fn = foo)
        };

        let keyword = Keyword::from_meta(&parse2(meta).unwrap()).unwrap();
        assert_eq!(keyword.ty, parse_quote!(u32));
        assert_eq!(keyword.func, parse_quote!(foo));
    }

    #[test]
    fn flatten_keywords() {
        let meta = quote! {
            outer(ref = "u32", type = "i32", fn = bar)
        };

        let keyword = FlattenKeyword::from_meta(&parse2(meta).unwrap()).unwrap();
        assert_eq!(keyword.reference, parse_quote!(u32));
        assert_eq!(keyword.keyword.ty, parse_quote!(i32));
        assert_eq!(keyword.keyword.func, parse_quote!(bar));
    }

    #[test]
    fn enum_keywords() {
        let enum_ = quote! {
            outer(enum)
        };

        let unit_enum = UnitEnumKeyword::from_meta(&parse2(enum_).unwrap()).unwrap();
        assert_eq!(unit_enum, UnitEnumKeyword::Enum);

        let struct_ = quote! {
            outer(struct)
        };
        let unit_enum = UnitEnumKeyword::from_meta(&parse2(struct_).unwrap()).unwrap();
        assert_eq!(unit_enum, UnitEnumKeyword::Struct);
    }

    #[test]
    fn flatten_enum_keywords() {
        let meta = quote! {
            outer(ref = "u32", enum)
        };

        let keyword = FlattenEnumKeyword::from_meta(&parse2(meta).unwrap()).unwrap();
        assert_eq!(keyword.reference, parse_quote!(u32));
        assert_eq!(keyword.keyword, UnitEnumKeyword::Enum);

        let meta = quote! {
            outer(ref = "u32", struct)
        };

        let keyword = FlattenEnumKeyword::from_meta(&parse2(meta).unwrap()).unwrap();
        assert_eq!(keyword.reference, parse_quote!(u32));
        assert_eq!(keyword.keyword, UnitEnumKeyword::Struct);
    }
}

mod from_none_struct_closure {
    use darling::FromMeta;
    use syn::parse_quote;

    #[derive(Debug, FromMeta)]
    struct Outer {
        // Do NOT add `darling(default)` here; this is testing the `from_none` fallback
        // invoked when a field is not declared and no `default` is specified.
        speech: Example,
    }

    #[derive(Debug, FromMeta)]
    #[darling(from_none = || Some(Default::default()))]
    struct Example {
        max_volume: u32,
    }

    impl Default for Example {
        fn default() -> Self {
            Example { max_volume: 3 }
        }
    }

    #[test]
    fn absent_gets_from_none() {
        let thing = Outer::from_list(&[]).unwrap();
        assert_eq!(thing.speech.max_volume, 3);
    }

    #[test]
    fn word_errors() {
        let error = Outer::from_list(&[parse_quote!(speech)])
            .expect_err("speech should require its fields if declared");
        assert_eq!(error.len(), 1);
    }

    #[test]
    fn list_sets_field() {
        let thing = Outer::from_list(&[parse_quote!(speech(max_volume = 5))]).unwrap();
        assert_eq!(thing.speech.max_volume, 5);
    }
}

mod from_none_struct_path {
    use darling::FromMeta;
    use syn::parse_quote;

    #[derive(Debug, FromMeta)]
    struct Outer {
        // Do NOT add `darling(default)` here; this is testing the `from_none` fallback
        // invoked when a field is not declared and no `default` is specified.
        speech: Example,
    }

    fn from_none_fallback() -> Option<Example> {
        Some(Example { max_volume: 3 })
    }

    #[derive(Debug, FromMeta)]
    #[darling(from_none = from_none_fallback)]
    struct Example {
        max_volume: u32,
    }

    #[test]
    fn absent_gets_from_none() {
        let thing = Outer::from_list(&[]).unwrap();
        assert_eq!(thing.speech.max_volume, 3);
    }

    #[test]
    fn word_errors() {
        let error = Outer::from_list(&[parse_quote!(speech)])
            .expect_err("speech should require its fields if declared");
        assert_eq!(error.len(), 1);
    }

    #[test]
    fn list_sets_field() {
        let thing = Outer::from_list(&[parse_quote!(speech(max_volume = 5))]).unwrap();
        assert_eq!(thing.speech.max_volume, 5);
    }
}

mod from_word_struct_closure {
    use darling::FromMeta;
    use syn::parse_quote;

    #[derive(FromMeta)]
    struct Outer {
        #[darling(default)]
        speech: Example,
    }

    #[derive(FromMeta, Default)]
    #[darling(from_word = || Ok(Example { max_volume: 10 }))]
    struct Example {
        max_volume: u32,
    }

    #[test]
    fn absent_gets_default() {
        let thing = Outer::from_list(&[]).unwrap();
        assert_eq!(thing.speech.max_volume, 0);
    }

    #[test]
    fn word_gets_value() {
        let thing = Outer::from_list(&[parse_quote!(speech)]).unwrap();
        assert_eq!(thing.speech.max_volume, 10);
    }

    #[test]
    fn list_sets_field() {
        let thing = Outer::from_list(&[parse_quote!(speech(max_volume = 5))]).unwrap();
        assert_eq!(thing.speech.max_volume, 5);
    }
}

mod from_word_struct_path {
    use darling::FromMeta;
    use syn::parse_quote;

    #[derive(FromMeta)]
    struct Outer {
        #[darling(default)]
        speech: Example,
    }

    fn max_volume_10() -> darling::Result<Example> {
        Ok(Example { max_volume: 10 })
    }

    #[derive(FromMeta, Default)]
    #[darling(from_word = max_volume_10)]
    struct Example {
        max_volume: u32,
    }

    #[test]
    fn absent_gets_default() {
        let thing = Outer::from_list(&[]).unwrap();
        assert_eq!(thing.speech.max_volume, 0);
    }

    #[test]
    fn word_gets_value() {
        let thing = Outer::from_list(&[parse_quote!(speech)]).unwrap();
        assert_eq!(thing.speech.max_volume, 10);
    }

    #[test]
    fn list_sets_field() {
        let thing = Outer::from_list(&[parse_quote!(speech(max_volume = 5))]).unwrap();
        assert_eq!(thing.speech.max_volume, 5);
    }
}

mod from_word_enum_closure {
    use darling::FromMeta;
    use syn::parse_quote;

    #[derive(Debug, FromMeta)]
    struct Outer {
        speech: Example,
    }

    #[derive(Debug, FromMeta, PartialEq, Eq)]
    #[darling(from_word = || Ok(Example::Left { max_volume: 10 }))]
    enum Example {
        Left { max_volume: u32 },
        Right { speed: u32 },
    }

    #[test]
    fn word_gets_value() {
        let thing = Outer::from_list(&[parse_quote!(speech)]).unwrap();
        assert_eq!(thing.speech, Example::Left { max_volume: 10 });
    }

    #[test]
    fn list_sets_field() {
        let thing = Outer::from_list(&[parse_quote!(speech(left(max_volume = 5)))]).unwrap();
        assert_eq!(thing.speech, Example::Left { max_volume: 5 });
    }

    #[test]
    fn variant_word_fails() {
        let thing = Outer::from_list(&[parse_quote!(speech(left))]).expect_err(
            "A variant word is an error because from_word applies at the all-up enum level",
        );
        assert_eq!(thing.len(), 1);
    }
}