derive_builder 0.20.2

Rust macro to automatically implement the builder pattern for arbitrary 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

// https://github.com/colin-kiegel/rust-derive-builder/issues/15
#[macro_use]
extern crate derive_builder;

#[derive(Debug, Clone, PartialEq)]
struct NotDefaultable(String);

fn new_notdefaultable() -> NotDefaultable {
    NotDefaultable("Lorem".to_string())
}

#[derive(Debug, PartialEq, Default, Builder, Clone)]
#[builder(setter(skip = false))]
struct SetterOptOut {
    setter_present_by_explicit_default: u32,
    #[builder(setter(skip = true))]
    setter_skipped_by_explicit_opt_out: u32,
    #[builder(setter(skip))]
    setter_skipped_by_shorthand_opt_out: u32,
    #[builder(setter(skip), default = "4")]
    setter_skipped_with_explicit_default: u32,
}

#[derive(Debug, PartialEq, Default, Builder, Clone)]
#[builder(setter(skip))]
struct SetterOptIn {
    setter_skipped_by_shorthand_default: u32,
    #[builder(setter(skip = false))]
    setter_present_by_explicit_opt_in: u32,
    #[builder(setter)]
    setter_present_by_shorthand_opt_in: u32,
    #[builder(setter(prefix = "set"))]
    setter_present_by_shorthand_opt_in_2: u32,
}

#[derive(Debug, PartialEq, Builder, Clone)]
#[builder(default, setter(skip))]
struct SetterOptInStructDefault {
    setter_skipped_with_struct_default: NotDefaultable,
    setter_skipped_with_type_default: u32,
}

#[derive(Debug, PartialEq, Builder, Clone)]
#[builder(setter(into))]
struct SetterOptInFieldDefault {
    #[builder(setter(skip), default = "new_notdefaultable()")]
    setter_skipped_with_field_default: NotDefaultable,

    #[builder(default)]
    setter_present_by_default: u32,
}

// compile test
#[allow(dead_code)]
impl SetterOptOut {
    // only possible if setter was skipped
    fn setter_skipped_by_explicit_opt_out() {}
    // only possible if setter was skipped
    fn setter_skipped_by_shorthand_opt_out() {}
}

// compile test
#[allow(dead_code)]
impl SetterOptIn {
    // only possible if setter was skipped
    fn setter_skipped_by_shorthand_default() {}
}

impl Default for SetterOptInStructDefault {
    fn default() -> Self {
        SetterOptInStructDefault {
            setter_skipped_with_struct_default: new_notdefaultable(),
            setter_skipped_with_type_default: Default::default(),
        }
    }
}

#[test]
fn setter_opt_out() {
    let x: SetterOptOut = SetterOptOutBuilder::default()
        .setter_present_by_explicit_default(42u32)
        .build()
        .unwrap();

    assert_eq!(
        x,
        SetterOptOut {
            setter_present_by_explicit_default: 42,
            setter_skipped_by_explicit_opt_out: 0,
            setter_skipped_by_shorthand_opt_out: 0,
            setter_skipped_with_explicit_default: 4,
        }
    );
}

#[test]
fn setter_opt_in() {
    let x: SetterOptIn = SetterOptInBuilder::default()
        .setter_present_by_explicit_opt_in(47u32)
        .setter_present_by_shorthand_opt_in(11u32)
        .set_setter_present_by_shorthand_opt_in_2(815u32)
        .build()
        .unwrap();

    assert_eq!(
        x,
        SetterOptIn {
            setter_skipped_by_shorthand_default: 0,
            setter_present_by_explicit_opt_in: 47,
            setter_present_by_shorthand_opt_in: 11,
            setter_present_by_shorthand_opt_in_2: 815,
        }
    );
}

#[test]
fn setter_skipped_with_struct_default() {
    let x = SetterOptInStructDefaultBuilder::default().build().unwrap();

    assert_eq!(x, SetterOptInStructDefault::default());
}

#[test]
fn setter_skipped_with_field_default() {
    let x = SetterOptInFieldDefaultBuilder::default()
        .build()
        .expect("All fields were defaulted");

    assert_eq!(
        x,
        SetterOptInFieldDefault {
            setter_skipped_with_field_default: new_notdefaultable(),
            setter_present_by_default: Default::default(),
        }
    );
}