Derive builders for your structs.

Put #[builder] on your structs to derive a builder pattern for that struct. The builder can be used to create the struct from only required fields (those without the Option type) and modify the content of the struct.

A struct builder enforces required fields to be specified and allows optional arguments to be specified post-construction. This is done by defining a "params" struct that the builder depends on to be initialized. This struct defines all the fields in the original struct that don't have the "Option" type. Once the builder is initialized with the params, both required and optional fields can be updated by calling builder methods (using the identifiers with_<field>).

Examples

Using builder to build a request with named fields.

use struct_builder::builder;

#[builder]
#[derive(Debug, Clone, Ord, PartialOrd, Eq, PartialEq)]
pub struct CreateUserRequest<P> {
    pub email: String,
    pub first_name: Option<String>,
    pub last_name: Option<String>,
    pub age: Option<u64>,
    pub payload: P
}

fn main() {
    // Inherits attributes and generics from `CreateUserRequest`
    let params: CreateUserRequestParams<String> = CreateUserRequestParams {
        email: "john.doe@email.com".to_owned(),
        payload: "John Doe's User".to_owned()
    };

    let request = CreateUserRequest::builder(params)
        .with_first_name(Some("John".to_owned()))
        .with_age(Some(35))
        .build();
    
    assert_eq!(request.email, "john.doe@email.com".to_owned());
    assert_eq!(request.first_name, Some("John".to_owned()));
    assert_eq!(request.last_name, None);
    assert_eq!(request.age, Some(35));
}