type-state-builder 0.5.1

Type-state builder pattern derive macro with compile-time safety and enhanced ergonomics.
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
137
138
139
140
141
142
143
144

//! Basic Functionality Tests
//!
//! Tests the core type-state builder pattern functionality with simple structs

use type_state_builder::TypeStateBuilder;

#[derive(TypeStateBuilder)]
struct SimpleStruct {
    #[builder(required)]
    name: String,

    #[builder(required)]
    age: u32,

    optional_field: Option<String>,
}

#[test]
fn test_simple_struct_builder() {
    let instance = SimpleStruct::builder()
        .name("Alice".to_string())
        .age(30)
        .build();

    assert_eq!(instance.name, "Alice");
    assert_eq!(instance.age, 30);
    assert_eq!(instance.optional_field, None);
}

#[test]
fn test_simple_struct_builder_with_optional() {
    let instance = SimpleStruct::builder()
        .name("Bob".to_string())
        .age(25)
        .optional_field(Some("test".to_string()))
        .build();

    assert_eq!(instance.name, "Bob");
    assert_eq!(instance.age, 25);
    assert_eq!(instance.optional_field, Some("test".to_string()));
}

#[test]
fn test_method_chaining_order() {
    // Test that required fields can be set in any order
    let instance1 = SimpleStruct::builder()
        .name("Alice".to_string())
        .age(30)
        .build();

    let instance2 = SimpleStruct::builder()
        .age(30)
        .name("Alice".to_string())
        .build();

    assert_eq!(instance1.name, instance2.name);
    assert_eq!(instance1.age, instance2.age);
}

#[derive(TypeStateBuilder)]
struct OnlyOptionalStruct {
    field1: i32,
    field2: String,
}

#[test]
fn test_only_optional_fields() {
    let instance = OnlyOptionalStruct::builder().build();

    assert_eq!(instance.field1, 0); // Default::default()
    assert_eq!(instance.field2, ""); // Default::default()
}

#[test]
fn test_only_optional_fields_with_values() {
    let instance = OnlyOptionalStruct::builder()
        .field1(42)
        .field2("test".to_string())
        .build();

    assert_eq!(instance.field1, 42);
    assert_eq!(instance.field2, "test");
}

#[derive(TypeStateBuilder)]
struct OnlyRequiredStruct {
    #[builder(required)]
    field1: i32,

    #[builder(required)]
    field2: String,
}

#[test]
fn test_only_required_fields() {
    let instance = OnlyRequiredStruct::builder()
        .field1(42)
        .field2("test".to_string())
        .build();

    assert_eq!(instance.field1, 42);
    assert_eq!(instance.field2, "test");
}

#[derive(TypeStateBuilder)]
struct MixedStruct {
    #[builder(required)]
    required1: String,

    optional1: i32,

    #[builder(required)]
    required2: bool,

    optional2: Vec<String>,
}

#[test]
fn test_mixed_required_optional() {
    let instance = MixedStruct::builder()
        .required1("test".to_string())
        .required2(true)
        .build();

    assert_eq!(instance.required1, "test");
    assert!(instance.required2);
    assert_eq!(instance.optional1, 0);
    assert_eq!(instance.optional2, Vec::<String>::new());
}

#[test]
fn test_mixed_with_optional_values() {
    let instance = MixedStruct::builder()
        .required1("test".to_string())
        .optional1(42)
        .required2(false)
        .optional2(vec!["a".to_string(), "b".to_string()])
        .build();

    assert_eq!(instance.required1, "test");
    assert_eq!(instance.optional1, 42);
    assert!(!instance.required2);
    assert_eq!(instance.optional2, vec!["a".to_string(), "b".to_string()]);
}