typesafe_builder_derive 1.6.0

A procedural macro to generate type-safe builder patterns for Rust structs
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

use darling::{FromDeriveInput, FromField, util::Flag};
use syn::{Expr, Generics, Ident, Type};

#[derive(Debug, Clone)]
pub enum DefaultValue {
    Bare,
    Expression(Expr),
}

impl darling::FromMeta for DefaultValue {
    fn from_word() -> darling::Result<Self> {
        Ok(DefaultValue::Bare)
    }

    fn from_value(value: &syn::Lit) -> darling::Result<Self> {
        match value {
            syn::Lit::Str(s) => {
                let expr: Expr = syn::parse_str(&s.value())?;
                Ok(DefaultValue::Expression(expr))
            }
            _ => Err(darling::Error::unexpected_lit_type(value)),
        }
    }
}

#[derive(Debug, FromDeriveInput)]
#[darling(attributes(builder), supports(struct_named))]
pub struct Input {
    ident: Ident,
    generics: Generics,
    data: darling::ast::Data<(), InputField>,
    #[darling(rename = "name")]
    builder_name: Option<String>,
}

impl Input {
    pub fn ident(&self) -> &Ident {
        &self.ident
    }

    pub fn generics(&self) -> &Generics {
        &self.generics
    }

    pub fn data(&self) -> darling::ast::Data<&(), &InputField> {
        self.data.as_ref()
    }

    pub fn builder_name(&self) -> String {
        self.builder_name
            .clone()
            .unwrap_or_else(|| format!("{}Builder", self.ident))
    }
}

#[derive(Debug, FromField)]
#[darling(attributes(builder))]
pub struct InputField {
    ident: Option<Ident>,
    ty: Type,

    /// #[builder(optional)]
    #[darling(rename = "optional", default)]
    optional_flag: Flag,

    /// #[builder(required)]
    #[darling(rename = "required", default)]
    required_flag: Flag,

    /// #[builder(required_if"...")]
    #[darling(rename = "required_if", default)]
    required_if: Option<String>,

    /// #[builder(optional_if"...")]
    #[darling(rename = "optional_if", default)]
    optional_if: Option<String>,

    /// #[builder(default = "...")]
    #[darling(rename = "default", default)]
    default: Option<DefaultValue>,

    /// #[builder(into)]
    #[darling(rename = "into", default)]
    into_flag: Flag,
}

impl InputField {
    pub fn ident(&self) -> Option<&Ident> {
        self.ident.as_ref()
    }

    pub fn ty(&self) -> &Type {
        &self.ty
    }

    pub fn requirement(&self) -> syn::Result<Requirement> {
        let attribute_count = self.optional_flag.is_present() as u8
            + self.required_flag.is_present() as u8
            + self.required_if.is_some() as u8
            + self.optional_if.is_some() as u8
            + self.default.is_some() as u8;

        if attribute_count > 1 {
            return Err(syn::Error::new(
                self.ident.as_ref().unwrap().span(),
                "Multiple builder attributes specified. Only one of required, optional, required_if, optional_if, default is allowed",
            ));
        }

        if self.default.is_some() {
            Ok(Requirement::Default)
        } else if let Some(opt_if) = &self.optional_if {
            let expr_result: Result<Expr, _> = syn::parse_str(opt_if);
            let expr: Expr = expr_result?;
            Ok(Requirement::OptionalIf(expr))
        } else if let Some(req_if) = &self.required_if {
            let expr_result: Result<Expr, _> = syn::parse_str(req_if);
            let expr: Expr = expr_result?;
            Ok(Requirement::Conditional(expr))
        } else if self.required_flag.is_present() {
            Ok(Requirement::Always)
        } else if self.optional_flag.is_present() {
            Ok(Requirement::Optional)
        } else {
            Err(syn::Error::new(
                self.ident.as_ref().unwrap().span(),
                "missing required field",
            ))
        }
    }

    pub fn default(&self) -> Option<&DefaultValue> {
        self.default.as_ref()
    }

    pub fn into(&self) -> bool {
        self.into_flag.is_present()
    }
}

pub enum Requirement {
    Always,
    Optional,
    Conditional(Expr),
    OptionalIf(Expr),
    Default,
}