builder_m4cro 0.4.0

Simple derive macro to implement the builder pattern
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

[![ci](https://github.com/OkieOth/rs_observable/actions/workflows/rust.yml/badge.svg)](https://github.com/OkieOth/rs_builder_m4cro/actions/workflows/rust.yml)
[![crates.io](https://img.shields.io/crates/v/builder_m4cro.svg)](https://crates.io/crates/builder_m4cro)

This is a crate provides two simple macros:
* Builder - an implementation of the factory pattern
* BuilderFromDefault - factory pattern implementation that relies on the
    implementation of the Default trait, to provide customized init values


For more examples look at:
* Builder: `examples/builder/src/main.rs`
* BuilderFromDefault: `examples/builder_from_default/src/main.rs`

```rust
use builder_m4cro::Builder;

/// Custom type that's annotated with the Builder macro
#[derive(Builder, Debug)]
pub struct TestType {
    pub a_unsigned: u32,
    pub a_opt_unsigned: Option<u32>,
    pub a_string: String,
    pub a_opt_string: Option<String>,
}

/// The macro expandes to the following code
impl TestType {
    pub fn builder() -> TestTypeBuilder {
        TestTypeBuilder::new()
    }
}
pub struct TestTypeBuilder {
    a_unsigned: Option<u32>,
    a_string: Option<String>,
    a_opt_unsigned: Option<u32>,
    a_opt_string: Option<String>,
}
// ...

impl TestTypeBuilder {
    pub fn new() -> TestTypeBuilder {
        TestTypeBuilder::default()
    }
    pub fn a_unsigned(&mut self, a_unsigned: u32) -> &mut Self {
        self.a_unsigned = Some(a_unsigned);
        self
    }
    pub fn a_string(&mut self, a_string: &str) -> &mut Self {
        self.a_string = Some(a_string.to_string());
        self
    }
    pub fn a_opt_unsigned(&mut self, a_opt_unsigned: u32) -> &mut Self {
        self.a_opt_unsigned = Some(a_opt_unsigned);
        self
    }
    pub fn a_opt_string(&mut self, a_opt_string: &str) -> &mut Self {
        self.a_opt_string = Some(a_opt_string.to_string());
        self
    }
    pub fn build(&self) -> Result<TestType, String> {
        Ok(TestType {
            a_unsigned: self
                .a_unsigned
                .clone()
                .ok_or_else(|| {
                    let res = ::alloc::fmt::format(
                        format_args!("{0} is not set", "a_unsigned"),
                    );
                    res
                })?,
            a_string: self
                .a_string
                .clone()
                .ok_or_else(|| {
                    let res = ::alloc::fmt::format(
                        format_args!("{0} is not set", "a_string"),
                    );
                    res
                })?,
            a_opt_unsigned: self.a_opt_unsigned.clone(),
            a_opt_string: self.a_opt_string.clone(),
        })
    }
}
```


# Helper to support marco dev

```bash
# Install cargo expand
# https://github.com/dtolnay/cargo-expand
cargo install cargo-expand

# e. g. ...
cd examples/result_builder
cargo expand
```