struct_to_string 0.2.0

A Rust proc-macro library to convert struct definitions to a string representation. An example use case would be for API documentation, and you want to present the Rust struct's for the API response on a webpage.
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
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
/// This is the `struct_to_string` crate.
///
/// This crate provides a procedural macro to convert struct definitions
/// into a string representation. An example use case would be for
/// API documentation where you want to present the Rust structs for the
/// API response on a webpage.
extern crate proc_macro;
use proc_macro::TokenStream;
use quote::quote;
use quote::ToTokens;
use syn::{parse_macro_input, DeriveInput, Type};

/// The `StructToString` macro derives a `to_string` function for the struct.
///
/// # Example
/// ```
/// use struct_to_string::StructToString;
///
/// #[derive(StructToString)]
/// struct MyStruct {
///     field1: i32,
///     field2: String,
/// }
///
/// let my_struct_as_rust_string = MyStruct::to_rust_string();
///
/// // Struct to string can also be used to convert structs to other programming languages,
/// // including Python, TypeScript, Go, Java, and C#.
///
/// let my_struct_as_c_sharp_string = MyStruct::to_csharp_string();
/// ```
#[proc_macro_derive(StructToString)]
pub fn struct_to_string(input: TokenStream) -> TokenStream {
    let ast: DeriveInput = parse_macro_input!(input);
    let name = ast.ident;

    let mut rust_fields = String::new();
    let mut go_fields = String::new();
    let mut python_fields = String::new();
    let mut ts_fields = String::new();
    let mut java_fields = String::new();
    let mut csharp_fields = String::new();

    if let syn::Data::Struct(data_struct) = ast.data {
        for field in data_struct.fields {
            let field_name = field.ident.expect("Field name not found");
            let field_type = field.ty;
            let field_type_tokens = quote! { #field_type }.to_string().replace(" ", "");

            let is_optional = match &field_type {
                Type::Path(type_path) => {
                    let last_segment = &type_path.path.segments.last().unwrap().ident;
                    last_segment == "Option"
                }
                _ => false,
            };

            // Rust representation
            rust_fields.push_str(&format!("    {}: {},\n", field_name, field_type_tokens));

            // Go representation
            let ts_field_name = if is_optional {
                format!("{}?", field_name)
            } else {
                format!("{}", field_name)
            };

            // TypeScript representation
            ts_fields.push_str(&format!(
                "    {}: {};\n",
                ts_field_name,
                rust_type_to_ts_type(&field_type)
            ));

            // Python representation
            python_fields.push_str(&format!(
                "    {}: {}\n",
                field_name,
                rust_type_to_python_type(&field_type)
            ));

            // Go representation
            go_fields.push_str(&format!(
                "    {} {}\n",
                field_name,
                rust_type_to_go_type(&field_type)
            ));

            java_fields.push_str(&format!(
                "    {} {} {};\n",
                "public",
                rust_type_to_java_type(&field_type),
                field_name,
            ));

            csharp_fields.push_str(&format!(
                "    {} {} {};\n",
                "public",
                rust_type_to_csharp_type(&field_type),
                field_name,
            ));
        }
    }

    let gen = quote! {
        impl #name {
            pub fn to_rust_string() -> String {
                let mut res = String::from("struct ");
                res.push_str(stringify!(#name));
                res.push_str(" {\n");
                res.push_str(#rust_fields.trim_end_matches(",\n"));
                res.push_str("\n}");
                res
            }

            pub fn to_go_string() -> String {
                let mut res = String::from("type ");
                res.push_str(stringify!(#name));
                res.push_str(" struct {\n");
                res.push_str(#go_fields);
                res.push_str("}");
                res
            }

            pub fn to_python_string() -> String {
                let mut res = String::from("@dataclass_json\n@dataclass\nclass ");
                res.push_str(stringify!(#name));
                res.push_str(":\n");
                res.push_str(#python_fields);
                res
            }

            pub fn to_typescript_string() -> String {
                let mut res = String::from("interface ");
                res.push_str(stringify!(#name));
                res.push_str(" {\n");
                res.push_str(#ts_fields);
                res.push_str("}");
                res
            }

            pub fn to_java_string() -> String {
                let mut res = String::from("public class ");
                res.push_str(stringify!(#name));
                res.push_str(" {\n");
                res.push_str(#java_fields);
                res.push_str("}");
                res
            }

            pub fn to_csharp_string() -> String {
                let mut res = String::from("public class ");
                res.push_str(stringify!(#name));
                res.push_str(" {\n");
                res.push_str(#csharp_fields);
                res.push_str("}");
                res
            }
        }
    };

    gen.into()
}

fn rust_type_to_ts_type(ty: &Type) -> String {
    match ty {
        Type::Path(type_path) => {
            let last_segment = type_path.path.segments.last().unwrap().ident.to_string();
            match last_segment.as_str() {
                "i32" | "u32" | "i64" | "u64" => "number",
                "f32" | "f64" => "number",
                "bool" => "boolean",
                "String" => "string",
                "char" => "string",
                "Option" => {
                    let arguments = &type_path.path.segments.last().unwrap().arguments;
                    if let syn::PathArguments::AngleBracketed(angle_bracketed_args) = arguments {
                        if let Some(syn::GenericArgument::Type(inner_type)) =
                            angle_bracketed_args.args.first()
                        {
                            return format!("{} | null", rust_type_to_ts_type(inner_type));
                        }
                    }
                    "any"
                }
                "Vec" => {
                    let arguments = &type_path.path.segments.last().unwrap().arguments;
                    if let syn::PathArguments::AngleBracketed(angle_bracketed_args) = arguments {
                        if let Some(syn::GenericArgument::Type(inner_type)) =
                            angle_bracketed_args.args.first()
                        {
                            return format!("{}[]", rust_type_to_ts_type(inner_type));
                        }
                    }
                    "any[]"
                }
                _ => &last_segment, // Fallback to the actual Rust type name, assuming it's a custom type or enum.
            }
            .to_string()
        }
        Type::Array(array) => {
            let inner_type = rust_type_to_ts_type(&array.elem);
            format!("{}[]", inner_type)
        }
        Type::Tuple(tuple) => {
            let types: Vec<String> = tuple
                .elems
                .iter()
                .map(|elem| rust_type_to_ts_type(elem))
                .collect();
            format!("[{}]", types.join(", "))
        }
        _ => "any".to_string(), // Fallback to 'any' for unsupported or complex types.
    }
}

fn rust_type_to_python_type(ty: &Type) -> String {
    match ty {
        Type::Path(type_path) => {
            let last_segment = type_path.path.segments.last().unwrap().ident.to_string();
            match last_segment.as_str() {
                "i32" | "u32" | "i64" | "u64" => "int",
                "f32" | "f64" => "float",
                "bool" => "bool",
                "String" => "str",
                "char" => "str",
                "Option" => {
                    let arguments = &type_path.path.segments.last().unwrap().arguments;
                    if let syn::PathArguments::AngleBracketed(angle_bracketed_args) = arguments {
                        if let Some(syn::GenericArgument::Type(inner_type)) =
                            angle_bracketed_args.args.first()
                        {
                            return format!("Optional[{}]", rust_type_to_python_type(inner_type));
                        }
                    }
                    "any"
                }
                "Vec" => {
                    let arguments = &type_path.path.segments.last().unwrap().arguments;
                    if let syn::PathArguments::AngleBracketed(angle_bracketed_args) = arguments {
                        if let Some(syn::GenericArgument::Type(inner_type)) =
                            angle_bracketed_args.args.first()
                        {
                            return format!("List[{}]", rust_type_to_python_type(inner_type));
                        }
                    }
                    "any[]"
                }
                _ => &last_segment, // Fallback to the actual Rust type name, assuming it's a custom type or enum.
            }
            .to_string()
        }
        Type::Array(array) => {
            let inner_type = rust_type_to_python_type(&array.elem);
            format!("List[{}]", inner_type)
        }
        Type::Tuple(tuple) => {
            let types: Vec<String> = tuple
                .elems
                .iter()
                .map(|elem| rust_type_to_python_type(elem))
                .collect();
            format!("Tuple[{}]", types.join(", "))
        }
        _ => "any".to_string(), // Fallback to 'any' for unsupported or complex types.
    }
}

fn rust_type_to_go_type(ty: &Type) -> String {
    match ty {
        Type::Path(type_path) => {
            let last_segment = type_path.path.segments.last().unwrap().ident.to_string();
            match last_segment.as_str() {
                "i8" => "int8",
                "u8" => "uint8",
                "i16" => "int16",
                "u16" => "uint16",
                "i32" => "int32",
                "u32" => "uint32",
                "i64" => "int64",
                "u64" => "uint64",
                "i128" => "big.Int",
                "u128" => "big.Int",
                "f32" => "float32",
                "f64" => "float64",
                "bool" => "bool",
                "String" => "string",
                "char" => "rune",
                "&str" => "string",
                "Option" => {
                    let arguments = &type_path.path.segments.last().unwrap().arguments;
                    if let syn::PathArguments::AngleBracketed(angle_bracketed_args) = arguments {
                        if let Some(syn::GenericArgument::Type(inner_type)) =
                            angle_bracketed_args.args.first()
                        {
                            return format!("*{}", rust_type_to_go_type(inner_type));
                        }
                    }
                    "any"
                }
                "Vec" => {
                    let arguments = &type_path.path.segments.last().unwrap().arguments;
                    if let syn::PathArguments::AngleBracketed(angle_bracketed_args) = arguments {
                        if let Some(syn::GenericArgument::Type(inner_type)) =
                            angle_bracketed_args.args.first()
                        {
                            return format!("[]{}", rust_type_to_go_type(inner_type));
                        }
                    }
                    "any[]"
                }
                _ => &last_segment, // Fallback to the actual Rust type name, assuming it's a custom type or enum.
            }
            .to_string()
        }
        Type::Array(array) => {
            let inner_type = rust_type_to_go_type(&array.elem);
            let array_length = match &array.len {
                syn::Expr::Lit(expr_lit) => {
                    if let syn::Lit::Int(lit_int) = &expr_lit.lit {
                        lit_int.base10_parse::<usize>().unwrap()
                    } else {
                        let lit_token_stream = expr_lit.lit.to_token_stream();
                        panic!(
                            "Invalid array length expression: {}",
                            quote!(#lit_token_stream)
                        );
                    }
                }
                _ => panic!("Invalid array length expression:"),
            };
            format!("[{}]{}", array_length, inner_type)
        }
        Type::Tuple(tuple) => {
            let types: Vec<String> = tuple
                .elems
                .iter()
                .map(|elem| rust_type_to_go_type(elem))
                .collect();
            format!(
                "struct{{}} // CANNOT CONVERT THIS TO THE GO PROGRAMMING LANGUAGE. TUPLES ARE UNSUPPORTED BY GO: ({})",
                types.join(", ")
            )
        }
        _ => "any".to_string(), // Fallback to 'any' for unsupported or complex types.
    }
}

fn rust_type_to_java_type(ty: &Type) -> String {
    match ty {
        Type::Path(type_path) => {
            let last_segment = type_path.path.segments.last().unwrap().ident.to_string();
            match last_segment.as_str() {
                "i8" => "byte",
                "u8" => "short",
                "i16" => "short",
                "u16" => "int",
                "i32" => "int",
                "u32" => "long",
                "i64" => "long",
                "u64" => "BigInteger",
                "i128" => "BigInteger",
                "u128" => "BigInteger",
                "f32" => "float",
                "f64" => "double",
                "bool" => "boolean",
                "String" => "String",
                "char" => "char",
                "Option" => {
                    let arguments = &type_path.path.segments.last().unwrap().arguments;
                    if let syn::PathArguments::AngleBracketed(angle_bracketed_args) = arguments {
                        if let Some(syn::GenericArgument::Type(inner_type)) =
                            angle_bracketed_args.args.first()
                        {
                            return format!(
                                "{}",
                                convert_java_primitive_type_to_wrapper_class(
                                    rust_type_to_java_type(inner_type).as_str()
                                )
                            );
                        }
                    }
                    "Object"
                }
                "Vec" => {
                    let arguments = &type_path.path.segments.last().unwrap().arguments;
                    if let syn::PathArguments::AngleBracketed(angle_bracketed_args) = arguments {
                        if let Some(syn::GenericArgument::Type(inner_type)) =
                            angle_bracketed_args.args.first()
                        {
                            return format!(
                                "List<{}>",
                                convert_java_primitive_type_to_wrapper_class(
                                    rust_type_to_java_type(inner_type).as_str()
                                )
                            );
                        }
                    }
                    "List<Object>"
                }
                _ => &last_segment, // Fallback to the actual Rust type name, assuming it's a custom type or enum.
            }
            .to_string()
        }
        Type::Array(array) => {
            let inner_type = rust_type_to_java_type(&array.elem);
            format!("{}[]", &inner_type)
        }
        Type::Tuple(tuple) => {
            let types: Vec<String> = tuple
                .elems
                .iter()
                .map(|elem| {
                    convert_java_primitive_type_to_wrapper_class(
                        rust_type_to_java_type(elem).as_str(),
                    )
                })
                .collect();
            format!("Tuple<{}>", types.join(", "))
        }
        _ => "Object".to_string(), // Fallback to 'Object' for unsupported or complex types.
    }
}

fn convert_java_primitive_type_to_wrapper_class(inner_type: &str) -> String {
    match inner_type {
        "byte" => "Byte",
        "short" => "Short",
        "int" => "Integer",
        "long" => "Long",
        "float" => "Float",
        "double" => "Double",
        "char" => "Character",
        "boolean" => "Boolean",
        _ => inner_type,
    }
    .to_string()
}

fn rust_type_to_csharp_type(ty: &Type) -> String {
    match ty {
        Type::Path(type_path) => {
            let last_segment = type_path.path.segments.last().unwrap().ident.to_string();
            match last_segment.as_str() {
                "i8" => "sbyte",
                "u8" => "byte",
                "i16" => "short",
                "u16" => "ushort",
                "i32" => "int",
                "u32" => "uint",
                "i64" => "long",
                "u64" => "ulong",
                "i128" => "BigInteger",
                "u128" => "BigInteger",
                "f32" => "float",
                "f64" => "double",
                "bool" => "bool",
                "String" => "string",
                "char" => "char",
                "Option" => {
                    let arguments = &type_path.path.segments.last().unwrap().arguments;
                    if let syn::PathArguments::AngleBracketed(angle_bracketed_args) = arguments {
                        if let Some(syn::GenericArgument::Type(inner_type)) =
                            angle_bracketed_args.args.first()
                        {
                            return format!("{}?", rust_type_to_csharp_type(inner_type));
                        }
                    }
                    "Object"
                }
                "Vec" => {
                    let arguments = &type_path.path.segments.last().unwrap().arguments;
                    if let syn::PathArguments::AngleBracketed(angle_bracketed_args) = arguments {
                        if let Some(syn::GenericArgument::Type(inner_type)) =
                            angle_bracketed_args.args.first()
                        {
                            return format!("List<{}>", rust_type_to_csharp_type(inner_type));
                        }
                    }
                    "List<Object>"
                }
                _ => &last_segment, // Fallback to the actual Rust type name, assuming it's a custom type or enum.
            }
            .to_string()
        }
        Type::Array(array) => {
            let inner_type = rust_type_to_csharp_type(&array.elem);
            format!("{}[]", &inner_type)
        }
        Type::Tuple(tuple) => {
            let types: Vec<String> = tuple
                .elems
                .iter()
                .map(|elem| rust_type_to_csharp_type(elem))
                .collect();
            format!("({})", types.join(", "))
        }
        _ => "Object".to_string(), // Fallback to 'Object' for unsupported or complex types.
    }
}