nnn-macros 1.0.1

Generate your newtypes from a single 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

/* Built-in imports */
extern crate alloc;
use alloc::format;
use core::iter;
/* Crate imports */
use super::Validator;
use crate::{codegen, utils::syn_ext::SynPathExt as _};
/* Dependencies */
use syn::{
    parse::{Parse, ParseStream},
    parse_quote,
};

pub(crate) enum Derive {
    Eq(syn::Path),
    Ord(syn::Path),
    Deserialize(syn::Path),
    /// A derive that will be passed down transparently.
    Transparent(syn::Path),
}

impl Parse for Derive {
    fn parse(input: ParseStream) -> syn::Result<Self> {
        let trait_path = syn::Path::parse(input)?;
        match trait_path.item_name()?.as_str()
        {
            // Special cases
            "Eq" => Ok(Self::Eq(trait_path)),
            "Ord" => Ok(Self::Ord(trait_path)),
            "Deserialize" => Ok(Self::Deserialize(trait_path)),
            // Forbidden derives
            derive_more @ (
                "Add" | "AddAssign" | "Constructor" | "Div" | "DivAssign" | "From" | "FromStr" | "Mul" | "MulAssign" | "Neg" | "Rem" | "RemAssign" | "Shl" | "ShlAssign" | "Shr" | "ShrAssign" | "Sub" | "SubAssign" | "Sum"
            ) => Err(syn::Error::new_spanned(
                trait_path,
                format!("Deriving `{derive_more}` results in a possible bypass of the validators and sanitizers and is therefore forbidden.")
            )),
            "Default" => Err(syn::Error::new_spanned(
                trait_path,
                "To derive the `Default` trait, use the `default` or `default = ..` argument."
            )),
            _ => Ok(Self::Transparent(trait_path)),
        }
    }
}

impl codegen::Gen for Derive {
    fn gen_impl(
        &self,
        ctx: &crate::Context,
    ) -> impl Iterator<Item = codegen::Implementation> {
        let is_nan_excluded_for_floats = ctx
            .args()
            .validators
            .iter()
            .any(Validator::excludes_float_nan);

        iter::once(match *self {
            Self::Eq(ref path) => {
                if is_nan_excluded_for_floats {
                    let type_name = ctx.type_name();
                    let (impl_generics, ty_generics, where_clause) =
                        ctx.generics().split_for_impl();
                    codegen::Implementation::ItemImpl(parse_quote! {
                        impl #impl_generics #path for #type_name #ty_generics #where_clause {}
                    })
                } else {
                    codegen::Implementation::Attribute(
                        parse_quote! { #[derive(#path)] },
                    )
                }
            },
            Self::Ord(ref path) => {
                if is_nan_excluded_for_floats {
                    let type_name = ctx.type_name();
                    let (impl_generics, ty_generics, where_clause) =
                        ctx.generics().split_for_impl();
                    let panic_msg = format!("{type_name}::cmp() panicked, because partial_cmp() returned None. Could it be that you're using unsafe {type_name}::new_unchecked() ?");
                    codegen::Implementation::ItemImpl(parse_quote! {
                        #[expect(clippy::derive_ord_xor_partial_ord, reason = "Manual impl when involving floats.")]
                        impl #impl_generics #path for #type_name #ty_generics #where_clause {
                            fn cmp(&self, other: &Self) -> ::core::cmp::Ordering {
                                self.partial_cmp(other)
                                    .unwrap_or_else(|| panic!(#panic_msg))
                            }
                        }
                    })
                } else {
                    codegen::Implementation::Attribute(
                        parse_quote! { #[derive(#path)] },
                    )
                }
            },
            Self::Deserialize(ref path) => {
                codegen::Implementation::Attribute(parse_quote! {
                    #[derive(#path)]
                    #[serde(try_from = "<Self as nnn::NNNewType>::Inner")]
                })
            },
            Self::Transparent(ref path) => codegen::Implementation::Attribute(
                parse_quote! { #[derive(#path)] },
            ),
        })
    }
}