typed-builder 0.8.0

Compile-time type-checked builder derive
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

use typed_builder::TypedBuilder;

#[derive(PartialEq, TypedBuilder)]
struct Foo {
    // Mandatory Field:
    x: i32,

    // #[builder(default)] without parameter - use the type's default
    // #[builder(setter(strip_option))] - wrap the setter argument with `Some(...)`
    #[builder(default, setter(strip_option))]
    y: Option<i32>,

    // Or you can set the default
    #[builder(default = 20)]
    z: i32,
}

fn main() {
    assert!(
        Foo::builder().x(1).y(2).z(3).build()
            == Foo {
                x: 1,
                y: Some(2),
                z: 3,
            }
    );

    // Change the order of construction:
    assert!(
        Foo::builder().z(1).x(2).y(3).build()
            == Foo {
                x: 2,
                y: Some(3),
                z: 1,
            }
    );

    // Optional fields are optional:
    assert!(
        Foo::builder().x(1).build()
            == Foo {
                x: 1,
                y: None,
                z: 20,
            }
    );

    // This will not compile - because we did not set x:
    // Foo::builder().build();

    // This will not compile - because we set y twice:
    // Foo::builder().x(1).y(2).y(3);
}