derive_builder_core_fork_arti/
lib.rs

1//! Internal helper library for the `derive_builder` crate.
2//!
3//! ## **THIS IS A FORK**
4//!
5//! This version of `derive_builder` has an additional `sub_builder` feature,
6//! which [has not been accepted upstream](https://github.com/colin-kiegel/rust-derive-builder/issues/254).
7//! We may add further additional features.
8//!
9//! In other respects, this fork is likely to lag behind the upstream crate.
10//!
11//! **Important Note**:
12//!
13//! * You are probably looking for the [`derive_builder`] crate,
14//!   which wraps this crate and is much more ergonomic to use.
15//!
16//! ## Purpose
17//!
18//! This is an internal helper library of [`derive_builder`], which allows for
19//! all the logic of builder creation to be decoupled from the proc-macro entry
20//! point.
21//!
22//!
23//! [`derive_builder`]: https://!crates.io/crates/derive_builder
24//! [`derive_builder_core`]: https://!crates.io/crates/derive_builder_core
25
26#![deny(warnings, missing_docs)]
27#![cfg_attr(test, recursion_limit = "100")]
28
29#[macro_use]
30extern crate darling;
31
32extern crate proc_macro;
33extern crate proc_macro2;
34#[macro_use]
35extern crate syn;
36#[macro_use]
37extern crate quote;
38#[cfg(test)]
39#[macro_use]
40extern crate pretty_assertions;
41
42mod block;
43mod build_method;
44mod builder;
45mod builder_field;
46mod default_expression;
47mod deprecation_notes;
48mod doc_comment;
49mod initializer;
50mod macro_options;
51mod options;
52mod setter;
53
54pub(crate) use block::BlockContents;
55pub(crate) use build_method::BuildMethod;
56pub(crate) use builder::Builder;
57pub(crate) use builder_field::{BuilderField, BuilderFieldType};
58use darling::FromDeriveInput;
59pub(crate) use default_expression::DefaultExpression;
60pub(crate) use deprecation_notes::DeprecationNotes;
61pub(crate) use doc_comment::doc_comment_from;
62pub(crate) use initializer::{FieldConversion, Initializer};
63pub(crate) use options::{BuilderPattern, Each};
64pub(crate) use setter::Setter;
65
66const DEFAULT_STRUCT_NAME: &str = "__default";
67
68/// Derive a builder for a struct
69pub fn builder_for_struct(ast: syn::DeriveInput) -> proc_macro2::TokenStream {
70    let opts = match macro_options::Options::from_derive_input(&ast) {
71        Ok(val) => val,
72        Err(err) => {
73            return err.write_errors();
74        }
75    };
76
77    let mut builder = opts.as_builder();
78    let mut build_fn = opts.as_build_method();
79
80    builder.doc_comment(format!(
81        include_str!("doc_tpl/builder_struct.md"),
82        struct_name = ast.ident
83    ));
84    build_fn.doc_comment(format!(
85        include_str!("doc_tpl/builder_method.md"),
86        struct_name = ast.ident
87    ));
88
89    for field in opts.fields() {
90        builder.push_field(field.as_builder_field());
91        builder.push_setter_fn(field.as_setter());
92        build_fn.push_initializer(field.as_initializer());
93    }
94
95    builder.push_build_fn(build_fn);
96
97    quote!(#builder)
98}