gin-tonic 0.8.6

main gin-tonic crate - rust protobuf with gin and tonic
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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162

use protox::prost_reflect::{FieldDescriptor, MessageDescriptor, OneofDescriptor};

use crate::codegen::{case, enums, messages, module, utils, Generator};

pub(crate) fn generate(
    ctx: &Generator,
    parent: &mut module::Module,
    module_path: &str,
    ty: OneofDescriptor,
) {
    let fields = ty
        .fields()
        .filter(|field| !field.field_descriptor_proto().proto3_optional())
        .collect::<Vec<_>>();

    if fields.is_empty() {
        return;
    }

    let qualified_name = ty.full_name();
    if !ctx.filter(qualified_name) {
        return;
    }

    tracing::info!("generating wrapped one of: {qualified_name}");

    let attributes = ctx.attributes(qualified_name);

    let module = module::create_child(parent, module_path);

    let ty_name = case::convert(ty.name(), case::Case::Pascal);
    let ty_name = quote::format_ident!("{}", ty_name);

    let mut body = quote::quote!();

    for variant in ty.fields() {
        let id = variant.number();

        let variant_name = case::convert(variant.name(), case::Case::Pascal);
        let variant_name = quote::format_ident!("{}", variant_name);

        let variant_type = utils::field_type(ctx, qualified_name, &variant);
        let proto_attributes = utils::proto_attribute(&variant);

        if utils::is_unit_type(&variant_type) {
            body.extend(quote::quote! {
                #variant_name,
            });
        } else {
            body.extend(quote::quote! {
                #[gin(id = #id #proto_attributes)]
                #variant_name(#variant_type),
            });
        };
    }

    module.extend(quote::quote! {
        #[derive(Clone, Debug, Eq, PartialEq, OneOf)]
        #attributes
        pub enum #ty_name {
            #body
        }
    });
}

pub(crate) fn generate_unwrapped(
    ctx: &Generator,
    parent: &mut module::Module,
    module_path: &str,
    ty: OneofDescriptor,
) {
    let parent_message = ty.parent_message();
    let qualified_name = parent_message.full_name();

    tracing::info!("generating unwrapped one of: {qualified_name}");

    let attributes = ctx.attributes(qualified_name);

    let module = module::create_child(parent, module_path);

    let ty_name = case::convert(parent_message.name(), case::Case::Pascal);
    let ty_name = quote::format_ident!("{}", ty_name);

    let mut body = quote::quote!();

    for variant in ty.fields() {
        let id = variant.number();
        let variant_name = case::convert(variant.name(), case::Case::Pascal);
        let variant_name = quote::format_ident!("{}", variant_name);

        let variant_type = utils::field_type(ctx, qualified_name, &variant);
        let proto_attributes = utils::proto_attribute(&variant);

        if utils::is_unit_type(&variant_type) {
            body.extend(quote::quote! {
                #[gin(id = #id #proto_attributes)]
                #variant_name,
            });
        } else {
            body.extend(quote::quote! {
                #[gin(id = #id #proto_attributes)]
                #variant_name(#variant_type),
            });
        }
    }

    let item: syn::ItemEnum = syn::parse_quote! {
        #[derive(Clone, Debug, ::gin_tonic::OneOf)]
        #attributes
        pub enum #ty_name {
            #body
        }
    };

    module.extend(quote::quote! {
        #item
    });

    // Generate the parent's children, because we replaced the parent type.
    {
        let ty = ty.parent_message();

        let module_path = ty.name();

        for child in ty.child_enums() {
            enums::generate(ctx, module, module_path, child);
        }
        for child in ty.child_messages() {
            messages::generate(ctx, module, module_path, child);
        }
    }
}

/// an unwrappable one of is a message (struct) containing only the oneof field. in this case
/// we can skip generating the wrapper struct (therefore unwrap the oneof)
pub(crate) fn is_unwrappable_one_of(ty: &MessageDescriptor) -> Option<OneofDescriptor> {
    let field_count = ty.fields().count();

    for one_of in ty.oneofs() {
        // Optional fields are encoded as one_ofs, so we have to skip past those.
        let fields = one_of
            .fields()
            .filter(|field| !field.field_descriptor_proto().proto3_optional())
            .collect::<Vec<_>>();

        if fields.is_empty() {
            continue;
        }

        return (field_count == fields.len()).then_some(one_of);
    }

    None
}

pub(crate) fn fetch_one_of(field: &FieldDescriptor) -> Option<OneofDescriptor> {
    if !field.field_descriptor_proto().proto3_optional() {
        field.containing_oneof()
    } else {
        None
    }
}