bon_macros/builder/builder_gen/
finish_fn.rs

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
use super::member::{Member, PosFnMember};
use crate::util::prelude::*;

impl super::BuilderGenCtx {
    fn finish_fn_member_expr(&self, member: &Member) -> TokenStream {
        let member = match member {
            Member::Named(member) => member,
            Member::Skip(member) => {
                return member
                    .value
                    .as_ref()
                    .map(|value| quote! { (|| #value)() })
                    .unwrap_or_else(|| quote! { ::core::default::Default::default() });
            }
            Member::StartFn(member) => {
                let index = &member.index;
                let start_fn_args_field = &self.ident_pool.start_fn_args;

                return quote! { self.#start_fn_args_field.#index };
            }
            Member::FinishFn(member) => {
                return member
                    .conversion()
                    .unwrap_or_else(|| member.ident.to_token_stream());
            }
            Member::Field(member) => {
                let ident = &member.ident;
                return quote! { self.#ident };
            }
        };

        let index = &member.index;

        let named_members_field = &self.ident_pool.named_members;
        let member_field = quote! {
            self.#named_members_field.#index
        };

        let default = member
            .config
            .default
            .as_ref()
            .map(|default| default.value.as_ref());

        match default {
            Some(Some(default)) => {
                let default = if member.config.into.is_present() {
                    quote! { Into::into((|| #default)()) }
                } else {
                    quote! { #default }
                };

                quote! {
                    ::core::option::Option::unwrap_or_else(#member_field, || #default)
                }
            }
            Some(None) => {
                quote! {
                    ::core::option::Option::unwrap_or_default(#member_field)
                }
            }
            None => {
                // For `Option` the default value is always `None`. So we can just return
                // the value of the member field itself (which is already an `Option<T>`).
                if member.is_special_option_ty() {
                    return member_field;
                }

                quote! {
                    unsafe {
                        // SAFETY: we know that the member is set because we are in
                        // the `finish` function where this method uses the trait
                        // bound of `IsSet` for every required member. It's also
                        // not possible to intervene with the builder's state from
                        // the outside because all members of the builder are considered
                        // private (we even generate random names for them to make it
                        // impossible to access them from the outside in the same module).
                        //
                        // We also make sure to use fully qualified paths to methods
                        // involved in setting the value for the required member to make
                        // sure no trait/function in scope can override the behavior.
                        ::core::option::Option::unwrap_unchecked(#member_field)
                    }
                }
            }
        }
    }

    pub(super) fn finish_fn(&self) -> TokenStream {
        let members_vars_decls = self.members.iter().map(|member| {
            let expr = self.finish_fn_member_expr(member);
            let var_ident = member.orig_ident();

            // The type hint is necessary in some cases to assist the compiler
            // in type inference.
            //
            // For example, if the expression is passed to a function that accepts
            // an impl Trait such as `impl Default`, and the expression itself looks
            // like `Default::default()`. In this case nothing hints to the compiler
            // the resulting type of the expression, so we add a type hint via an
            // intermediate variable here.
            //
            // This variable can also be accessed by other member's `default`
            // or `skip` expressions.
            let ty = member.norm_ty();

            quote! {
                let #var_ident: #ty = #expr;
            }
        });

        let state_mod = &self.state_mod.ident;

        let finish_fn_params = self
            .members
            .iter()
            .filter_map(Member::as_finish_fn)
            .map(PosFnMember::fn_input_param);

        let body = &self.finish_fn.body.generate(self);
        let asyncness = &self.finish_fn.asyncness;
        let unsafety = &self.finish_fn.unsafety;
        let must_use = &self.finish_fn.must_use;
        let attrs = &self.finish_fn.attrs;
        let finish_fn_vis = &self.finish_fn.vis;
        let finish_fn_ident = &self.finish_fn.ident;
        let output = &self.finish_fn.output;
        let state_var = &self.state_var;

        quote! {
            #(#attrs)*
            #[inline(always)]
            #[allow(
                // This is intentional. We want the builder syntax to compile away
                clippy::inline_always,

                // This lint flags any function that returns a possibly `!Send` future.
                // However, it doesn't apply in the generic context where the future is
                // `Send` if the generic parameters are `Send` as well, so we just suppress
                // this lint. See the issue: https://github.com/rust-lang/rust-clippy/issues/6947
                clippy::future_not_send,
                clippy::missing_const_for_fn,
            )]
            #must_use
            #finish_fn_vis #asyncness #unsafety fn #finish_fn_ident(self, #(#finish_fn_params,)*) #output
            where
                #state_var: #state_mod::IsComplete
            {
                #(#members_vars_decls)*
                #body
            }
        }
    }
}