trl_codegen 1.2.1

This library provides auto generation of some common methods based on Rust macros
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

//! # helpers
//!
//! This module contains some helper functions

use proc_macro2::TokenStream;
use quote::quote;
use syn::{Field, Fields, Ident, Type, Visibility};

use crate::{accessors::AccessorStructAttrs, modifier::Modifier};

pub fn fill_includes_if_empty(includes: &mut Vec<String>, fields: &Fields) {
    if !includes.is_empty() {
        return;
    }

    for field in fields.iter() {
        includes.push(field.ident.clone().unwrap().to_string());
    }
}

pub fn should_add_pub(attrs: &AccessorStructAttrs, field: &Field) -> bool {
    if !attrs.include_pub {
        if let Visibility::Public(..) = field.vis {
            return false;
        }
    };

    true
}

/// Checks whether the field should be included based on the `includes` and `excludes` arguments
pub fn should_include(attrs: &AccessorStructAttrs, field: &Field) -> bool {
    if !attrs
        .includes
        .contains(&field.ident.clone().unwrap().to_string())
        || attrs
            .excludes
            .contains(&field.ident.clone().unwrap().to_string())
    {
        return false;
    }

    true
}

/// Checks whether the field should be included based on the `StructAttrs` struct
pub fn should_field_be_added(attrs: &AccessorStructAttrs, field: &Field) -> bool {
    should_add_pub(&attrs, &field) && should_include(&attrs, &field)
}

/// Generate a single getter `TokenStream`
pub fn generate_getter(
    name: &Ident,
    modifier: &Modifier,
    field_name: &Ident,
    ty: &Type,
) -> TokenStream {
    let raw_modifier: TokenStream = modifier.into();
    let ret = quote! {#raw_modifier #ty};
    let body = quote! {#raw_modifier self.#field_name};

    generate_custom_getter(name, modifier, ret, body)
}

pub fn generate_custom_getter(
    name: &Ident,
    modifier: &Modifier,
    ret: TokenStream,
    body: TokenStream,
) -> TokenStream {
    let raw_modifier: TokenStream = modifier.into();
    quote! {
        pub fn #name(#raw_modifier self) -> #ret {
            #body
        }
    }
}

/// Generates a single setter `TokenStream`
pub fn generate_setter(name: &Ident, field_name: &Ident, ty: &Type) -> TokenStream {
    quote! {
        pub fn #name(&mut self, value: #ty) {
            self.#field_name = value;
        }
    }
}