buco 0.2.0

A compile-time builder pattern implementation for Rust
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

/// A trait for builder pattern.
///
/// This trait is implemented by the `Builder` derive macro. It provides a common interface for
/// setting fields of a struct and building the struct.
///
/// This purely works on build time and tries
/// to provide a compile time safety for building a struct, while allowing to set fields in any
/// order.
///
///
/// # Example
///
/// This is a simple example of how to use the `Builder` trait.
///
/// ```rust
/// use buco::Builder;
///
/// #[derive(Builder)]
/// struct Elements {
///     fire: u8,
///     water: String,
/// }
///
/// let elements = Elements::builder()
///    .set_water("water".to_string())
///    .set_fire(1)
///    .build();
/// ```
/// Similarly, if you miss setting a field, it will give a compile time error.
///
/// ```rust,compile_fail
/// use buco::Builder;
///
/// #[derive(Builder)]
/// struct Elements {
///     fire: u8,
///     water: String,
/// }
///
/// let elements = Elements::builder()
///    .set_water("water".to_string())
///    .build();
/// ```
///
///
pub trait Builder {}

pub use buco_derive::Builder;

#[cfg(test)]
mod tests {
    use super::*;
    use trybuild::TestCases;

    #[test]
    fn sanity_tests() {
        let t = TestCases::new();

        t.compile_fail("build_tests/01-builder-enum.rs");
        t.compile_fail("build_tests/02-builder-union.rs");
        t.pass("build_tests/03-builder-struct.rs");
        t.compile_fail("build_tests/04-builder-struct-partial.rs");
        t.pass("build_tests/05-builder-struct-complete.rs");
        t.compile_fail("build_tests/06-builder-struct-overwrite.rs");
        t.pass("build_tests/07-builder-struct-optional.rs");
        t.compile_fail("build_tests/08-builder-struct-optional-strict.rs");
    }

    #[test]
    fn test_common_builder() {
        #[derive(Builder)]
        struct Data {
            v1: u8,
            v2: String,
            v3: f64,
        }

        let data = Data::builder()
            .set_v1(1)
            .set_v2("hello".to_string())
            .set_v3(1.414)
            .build();

        assert_eq!(data.v1, 1);
        assert_eq!(data.v2, "hello");
        assert_eq!(data.v3, 1.414);
    }
}