strid-macros 10.0.0

Implementation macros for the `strid` crate
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
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
use quote::{ToTokens, quote};

use super::{OwnedCodeGen, RefCodeGen, check_mode::CheckMode};

#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum ImplOption {
    Implement,
    Omit,
}

impl ImplOption {
    fn map<F>(self, f: F) -> Option<proc_macro2::TokenStream>
    where
        F: FnOnce() -> proc_macro2::TokenStream,
    {
        match self {
            Self::Implement => Some(f()),
            Self::Omit => None,
        }
    }
}

impl std::str::FromStr for ImplOption {
    type Err = &'static str;

    fn from_str(s: &str) -> Result<Self, Self::Err> {
        match s {
            "impl" => Ok(Self::Implement),
            "omit" => Ok(Self::Omit),
            _ => Err("valid values are: `impl` or `omit`"),
        }
    }
}

#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum DelegatingImplOption {
    Implement,
    OwnedOnly,
    Omit,
}

impl DelegatingImplOption {
    fn map_owned<F>(self, f: F) -> Option<proc_macro2::TokenStream>
    where
        F: FnOnce() -> proc_macro2::TokenStream,
    {
        match self {
            Self::Implement | Self::OwnedOnly => Some(f()),
            Self::Omit => None,
        }
    }

    fn map_ref<F>(self, f: F) -> Option<proc_macro2::TokenStream>
    where
        F: FnOnce() -> proc_macro2::TokenStream,
    {
        match self {
            Self::Implement => Some(f()),
            Self::Omit | Self::OwnedOnly => None,
        }
    }
}

impl std::str::FromStr for DelegatingImplOption {
    type Err = &'static str;

    fn from_str(s: &str) -> Result<Self, Self::Err> {
        match s {
            "impl" => Ok(Self::Implement),
            "owned" => Ok(Self::OwnedOnly),
            "omit" => Ok(Self::Omit),
            _ => Err("valid values are: `impl`, `owned`, or `omit`"),
        }
    }
}

impl From<ImplOption> for DelegatingImplOption {
    fn from(opt: ImplOption) -> Self {
        match opt {
            ImplOption::Implement => Self::Implement,
            ImplOption::Omit => Self::Omit,
        }
    }
}

#[derive(Debug, Default)]
pub struct Impls {
    pub clone: ImplClone,
    pub debug: ImplDebug,
    pub display: ImplDisplay,
    pub ord: ImplOrd,
    pub serde: ImplSerde,
    pub rusqlite: ImplRusqlite,
    pub sailfish: ImplSailfish,
}

pub(crate) trait ToImpl {
    fn to_owned_impl(&self, _cg: &OwnedCodeGen) -> Option<proc_macro2::TokenStream> {
        None
    }

    fn to_borrowed_impl(&self, _cg: &RefCodeGen) -> Option<proc_macro2::TokenStream> {
        None
    }
}

#[derive(Debug)]
pub struct ImplClone(ImplOption);

impl Default for ImplClone {
    fn default() -> Self {
        Self(ImplOption::Implement)
    }
}

impl From<ImplOption> for ImplClone {
    fn from(opt: ImplOption) -> Self {
        Self(opt)
    }
}

impl ToImpl for ImplClone {
    fn to_owned_impl(&self, _cg: &OwnedCodeGen) -> Option<proc_macro2::TokenStream> {
        self.0.map(|| quote! { #[derive(Clone)] })
    }
}

#[derive(Debug)]
pub struct ImplDisplay(DelegatingImplOption);

impl Default for ImplDisplay {
    fn default() -> Self {
        Self(DelegatingImplOption::Implement)
    }
}

impl From<DelegatingImplOption> for ImplDisplay {
    fn from(opt: DelegatingImplOption) -> Self {
        Self(opt)
    }
}
impl ToImpl for ImplDisplay {
    fn to_owned_impl(&self, cg: &OwnedCodeGen) -> Option<proc_macro2::TokenStream> {
        let ty = cg.ty;
        let ref_ty = cg.ref_ty;
        let core = cg.std_lib.core();
        self.0.map_owned(|| {
            quote! {
                #[automatically_derived]
                impl ::#core::fmt::Display for #ty {
                    #[inline]
                    fn fmt(&self, f: &mut ::#core::fmt::Formatter) -> ::#core::fmt::Result {
                        <#ref_ty as ::#core::fmt::Display>::fmt(::#core::ops::Deref::deref(self), f)
                    }
                }
            }
        })
    }

    fn to_borrowed_impl(&self, cg: &RefCodeGen) -> Option<proc_macro2::TokenStream> {
        let ty = &cg.ty;
        let field_name = &cg.field.name;
        let core = cg.std_lib.core();
        self.0.map_ref(|| {
            quote! {
                #[automatically_derived]
                impl ::#core::fmt::Display for #ty {
                    #[inline]
                    fn fmt(&self, f: &mut ::#core::fmt::Formatter) -> ::#core::fmt::Result {
                        <str as ::#core::fmt::Display>::fmt(&self.#field_name, f)
                    }
                }
            }
        })
    }
}

#[derive(Debug)]
pub struct ImplDebug(DelegatingImplOption);

impl Default for ImplDebug {
    fn default() -> Self {
        Self(DelegatingImplOption::Implement)
    }
}

impl From<DelegatingImplOption> for ImplDebug {
    fn from(opt: DelegatingImplOption) -> Self {
        Self(opt)
    }
}

impl ToImpl for ImplDebug {
    fn to_owned_impl(&self, cg: &OwnedCodeGen) -> Option<proc_macro2::TokenStream> {
        let ty = cg.ty;
        let ref_ty = cg.ref_ty;
        let core = cg.std_lib.core();
        self.0.map_owned(|| {
            quote! {
                #[automatically_derived]
                impl ::#core::fmt::Debug for #ty {
                    #[inline]
                    fn fmt(&self, f: &mut ::#core::fmt::Formatter) -> ::#core::fmt::Result {
                        <#ref_ty as ::#core::fmt::Debug>::fmt(::#core::ops::Deref::deref(self), f)
                    }
                }
            }
        })
    }

    fn to_borrowed_impl(&self, cg: &RefCodeGen) -> Option<proc_macro2::TokenStream> {
        let ty = &cg.ty;
        let field_name = &cg.field.name;
        let core = cg.std_lib.core();
        self.0.map_ref(|| {
            quote! {
                #[automatically_derived]
                impl ::#core::fmt::Debug for #ty {
                    #[inline]
                    fn fmt(&self, f: &mut ::#core::fmt::Formatter) -> ::#core::fmt::Result {
                        <str as ::#core::fmt::Debug>::fmt(&self.#field_name, f)
                    }
                }
            }
        })
    }
}

#[derive(Debug)]
pub struct ImplOrd(DelegatingImplOption);

impl Default for ImplOrd {
    fn default() -> Self {
        Self(DelegatingImplOption::Implement)
    }
}

impl From<DelegatingImplOption> for ImplOrd {
    fn from(opt: DelegatingImplOption) -> Self {
        Self(opt)
    }
}

impl ToImpl for ImplOrd {
    fn to_owned_impl(&self, cg: &OwnedCodeGen) -> Option<proc_macro2::TokenStream> {
        let ty = &cg.ty;
        let field_name = &cg.field.name;
        let core = cg.std_lib.core();
        self.0.map_owned(|| quote! {
            #[automatically_derived]
            impl ::#core::cmp::Ord for #ty {
                #[inline]
                fn cmp(&self, other: &Self) -> ::#core::cmp::Ordering {
                    ::#core::cmp::Ord::cmp(&self.#field_name, &other.#field_name)
                }
            }

            #[automatically_derived]
            impl ::#core::cmp::PartialOrd for #ty {
                #[inline]
                fn partial_cmp(&self, other: &Self) -> ::#core::option::Option<::#core::cmp::Ordering> {
                    ::#core::cmp::PartialOrd::partial_cmp(&self.#field_name, &other.#field_name)
                }
            }
        })
    }

    fn to_borrowed_impl(&self, _cg: &RefCodeGen) -> Option<proc_macro2::TokenStream> {
        self.0.map_ref(|| quote! { #[derive(PartialOrd, Ord)] })
    }
}

#[derive(Debug)]
pub struct ImplRusqlite(ImplOption);

impl Default for ImplRusqlite {
    fn default() -> Self {
        Self(ImplOption::Omit)
    }
}

impl From<ImplOption> for ImplRusqlite {
    fn from(opt: ImplOption) -> Self {
        Self(opt)
    }
}

impl ToImpl for ImplRusqlite {
    fn to_owned_impl(&self, cg: &OwnedCodeGen) -> Option<proc_macro2::TokenStream> {
        self.0.map(|| {
            let name = cg.ty;
            let field_name = &cg.field.name;
            let handle_failure = cg.check_mode.rusqlite_err_handler();

            quote! {
                #[automatically_derived]
                impl ::rusqlite::types::ToSql for #name {
                    fn to_sql(&self) -> ::rusqlite::Result<::rusqlite::types::ToSqlOutput<'_>> {
                        self.#field_name.to_sql()
                    }
                }

                #[automatically_derived]
                impl ::rusqlite::types::FromSql for #name {
                    fn column_result(value: ::rusqlite::types::ValueRef<'_>) -> ::rusqlite::types::FromSqlResult<Self> {
                        let s = <::std::string::String as ::rusqlite::types::FromSql>::column_result(value)?;
                        ::std::result::Result::Ok(Self::new(s)#handle_failure)
                    }
                }
            }
        })
    }

    fn to_borrowed_impl(&self, cg: &RefCodeGen) -> Option<proc_macro2::TokenStream> {
        self.0.map(|| {
            let ty = &cg.ty;

            quote! {
                #[automatically_derived]
                impl ::rusqlite::types::ToSql for #ty {
                    fn to_sql(&self) -> ::rusqlite::Result<::rusqlite::types::ToSqlOutput<'_>> {
                        self.as_str().to_sql()
                    }
                }
            }
        })
    }
}

#[derive(Debug)]
pub struct ImplSailfish(ImplOption);

impl Default for ImplSailfish {
    fn default() -> Self {
        Self(ImplOption::Omit)
    }
}

impl From<ImplOption> for ImplSailfish {
    fn from(opt: ImplOption) -> Self {
        Self(opt)
    }
}

impl ToImpl for ImplSailfish {
    fn to_owned_impl(&self, cg: &OwnedCodeGen) -> Option<proc_macro2::TokenStream> {
        self.0.map(|| {
            let name = cg.ty;

            quote! {
                #[automatically_derived]
                impl ::sailfish::runtime::Render for #name {
                    #[inline]
                    fn render(&self, b: &mut ::sailfish::runtime::Buffer) -> ::std::result::Result<(), ::sailfish::runtime::RenderError> {
                        b.push_str(self.as_str());
                        ::std::result::Result::Ok(())
                    }
                }
            }
        })
    }

    fn to_borrowed_impl(&self, cg: &RefCodeGen) -> Option<proc_macro2::TokenStream> {
        self.0.map(|| {
            let ty = &cg.ty;

            quote! {
                #[automatically_derived]
                impl ::sailfish::runtime::Render for #ty {
                    #[inline]
                    fn render(&self, b: &mut ::sailfish::runtime::Buffer) -> ::std::result::Result<(), ::sailfish::runtime::RenderError> {
                        b.push_str(self.as_str());
                        ::std::result::Result::Ok(())
                    }
                }
            }
        })
    }
}

#[derive(Debug)]
pub struct ImplSerde(ImplOption);

impl Default for ImplSerde {
    fn default() -> Self {
        Self(ImplOption::Omit)
    }
}

impl From<ImplOption> for ImplSerde {
    fn from(opt: ImplOption) -> Self {
        Self(opt)
    }
}

impl ToImpl for ImplSerde {
    fn to_owned_impl(&self, cg: &OwnedCodeGen) -> Option<proc_macro2::TokenStream> {
        self.0.map(|| {
            let handle_failure = cg.check_mode.serde_err_handler();

            let name = cg.ty;
            let field_name = &cg.field.name;
            let wrapped_type = &cg.field.ty;

            quote! {
                #[automatically_derived]
                impl ::serde::Serialize for #name {
                    fn serialize<S: ::serde::Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
                        <#wrapped_type as ::serde::Serialize>::serialize(&self.#field_name, serializer)
                    }
                }

                #[allow(clippy::needless_question_mark, clippy::unsafe_derive_deserialize)]
                #[automatically_derived]
                impl<'de> ::serde::Deserialize<'de> for #name {
                    fn deserialize<D: ::serde::Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
                        let raw = <#wrapped_type as ::serde::Deserialize<'de>>::deserialize(deserializer)?;
                        Ok(Self::new(raw)#handle_failure)
                    }
                }
            }
        })
    }

    fn to_borrowed_impl(&self, cg: &RefCodeGen) -> Option<proc_macro2::TokenStream> {
        self.0.map(|| {
            let ty = &cg.ty;
            let check_mode = cg.check_mode;
            let core = cg.std_lib.core();
            let alloc = cg.std_lib.alloc();

            let handle_failure = check_mode.serde_err_handler();

            let deserialize_boxed = cg.owned_ty.map(|owned_ty| {
                quote! {
                    #[automatically_derived]
                    impl<'de> ::serde::Deserialize<'de> for ::#alloc::boxed::Box<#ty> {
                        fn deserialize<D: ::serde::Deserializer<'de>>(deserializer: D) -> ::#core::result::Result<Self, D::Error> {
                            let owned = <#owned_ty as ::serde::Deserialize<'de>>::deserialize(deserializer)?;
                            ::#core::result::Result::Ok(owned.into_boxed_ref())
                        }
                    }
                }
            });

            let deserialize = if matches!(check_mode, CheckMode::Normalize(_)) {
                let deserialize_doc = format!(
                    "Deserializes a `{ty}` in normalized form\n\
                    \n\
                    This deserializer _requires_ that the value already be in normalized form. \
                    If values may require normalization, then deserialized as [`{owned}`] or \
                    [`Cow<{ty}>`][{alloc}::borrow::Cow] instead.",
                    ty = ty.to_token_stream(),
                    owned = cg.owned_ty.expect("normalize not available if no owned").to_token_stream(),
                );

                quote! {
                    // impl<'de: 'a, 'a> ::serde::Deserialize<'de> for ::#alloc::borrow::Cow<'a, #name> {
                    //     fn deserialize<D: ::serde::Deserializer<'de>>(deserializer: D) -> ::#core::result::Result<Self, D::Error> {
                    //         let raw = <&str as ::serde::Deserialize<'de>>::deserialize(deserializer)?;
                    //         ::#core::result::Result::Ok(#name::from_str(raw)#handle_failure)
                    //     }
                    // }
                    //
                    #[doc = #deserialize_doc]
                    #[allow(clippy::needless_question_mark, clippy::unsafe_derive_deserialize)]
                    #[automatically_derived]
                    impl<'de: 'a, 'a> ::serde::Deserialize<'de> for &'a #ty {
                        fn deserialize<D: ::serde::Deserializer<'de>>(deserializer: D) -> ::#core::result::Result<Self, D::Error> {
                            let raw = <&str as ::serde::Deserialize<'de>>::deserialize(deserializer)?;
                            ::#core::result::Result::Ok(#ty::from_normalized_str(raw)#handle_failure)
                        }
                    }
                }
            } else {
                quote! {
                    #[allow(clippy::needless_question_mark, clippy::unsafe_derive_deserialize)]
                    #[automatically_derived]
                    impl<'de: 'a, 'a> ::serde::Deserialize<'de> for &'a #ty {
                        fn deserialize<D: ::serde::Deserializer<'de>>(deserializer: D) -> ::#core::result::Result<Self, D::Error> {
                            let raw = <&str as ::serde::Deserialize<'de>>::deserialize(deserializer)?;
                            ::#core::result::Result::Ok(#ty::from_str(raw)#handle_failure)
                        }
                    }
                }
            };

            quote! {
                #[automatically_derived]
                impl ::serde::Serialize for #ty {
                    fn serialize<S: ::serde::Serializer>(&self, serializer: S) -> ::#core::result::Result<S::Ok, S::Error> {
                        <str as ::serde::Serialize>::serialize(self.as_str(), serializer)
                    }
                }

                #deserialize
                #deserialize_boxed
            }
        })
    }
}