brk_bindgen 0.2.5

A trait-based generator of client bindings for multiple languages
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

//! Language-specific syntax traits for code generation.
//!
//! This module defines the `LanguageSyntax` trait that abstracts over
//! language-specific code generation patterns, allowing shared generation
//! logic to work across Python, JavaScript, and Rust backends.

use crate::GenericSyntax;

/// Language-specific syntax for code generation.
///
/// Implementations of this trait provide the language-specific formatting
/// for generated client code. This allows the core generation logic to be
/// written once and reused across all supported languages.
pub trait LanguageSyntax {
    /// Convert a field name to the language's naming convention.
    ///
    /// - Python/Rust: `snake_case`
    /// - JavaScript: `camelCase`
    fn field_name(&self, name: &str) -> String;

    /// Format an interpolated path expression.
    ///
    /// # Arguments
    /// * `base_var` - The variable name to interpolate (e.g., "acc", "base_path")
    /// * `suffix` - The suffix to append (e.g., "_field_name")
    ///
    /// # Returns
    /// - Python: `f'{acc}_suffix'`
    /// - JavaScript: `` `${acc}_suffix` ``
    /// - Rust: `format!("{acc}_suffix")`
    fn path_expr(&self, base_var: &str, suffix: &str) -> String;

    /// Format a suffix mode expression: `_m(acc, relative)`.
    ///
    /// Suffix mode appends the relative name to the accumulator.
    /// - If relative is empty, returns just acc (identity)
    /// - Otherwise: `{acc}_{relative}` or `{relative}` if acc is empty
    ///
    /// # Arguments
    /// * `acc_var` - The accumulator variable name (e.g., "acc")
    /// * `relative` - The relative name to append (e.g., "max_cost_basis")
    fn suffix_expr(&self, acc_var: &str, relative: &str) -> String;

    /// Format a prefix mode expression: `_p(prefix, acc)`.
    ///
    /// Prefix mode prepends the prefix to the accumulator.
    /// - If prefix is empty, returns just acc (identity)
    /// - Otherwise: `{prefix}{acc}` (prefix includes trailing underscore)
    ///
    /// # Arguments
    /// * `prefix` - The prefix to prepend (e.g., "cumulative_")
    /// * `acc_var` - The accumulator variable name (e.g., "acc")
    fn prefix_expr(&self, prefix: &str, acc_var: &str) -> String;

    /// Generate a constructor call for patterns and accessors.
    ///
    /// - Python: `TypeName(client, path)`
    /// - JavaScript: `createTypeName(client, path)`
    /// - Rust: `TypeName::new(client.clone(), path)`
    fn constructor(&self, type_name: &str, path_expr: &str) -> String;

    /// Generate a field initialization line.
    ///
    /// # Arguments
    /// * `indent` - The indentation string
    /// * `name` - The field name (already converted to language convention)
    /// * `type_ann` - The type annotation (may be ignored by some languages)
    /// * `value` - The initialization value/expression
    ///
    /// # Returns
    /// - Python: `{indent}self.{name}: {type_ann} = {value}`
    /// - JavaScript: `{indent}{name}: {value},`
    /// - Rust: `{indent}{name}: {value},`
    fn field_init(&self, indent: &str, name: &str, type_ann: &str, value: &str) -> String;

    /// Get the generic type syntax for this language.
    ///
    /// - Python: `[T]` with default `Any`
    /// - JavaScript: `<T>` with default `unknown`
    /// - Rust: `<T>` with default `_`
    fn generic_syntax(&self) -> GenericSyntax;

    /// Format a string literal.
    ///
    /// - Python/JavaScript: `'value'` (single quotes)
    /// - Rust: `"value"` (double quotes)
    fn string_literal(&self, value: &str) -> String;

    /// Get the constructor name/prefix for a type.
    ///
    /// - Python: `TypeName`
    /// - JavaScript: `createTypeName`
    /// - Rust: `TypeName::new`
    fn constructor_name(&self, type_name: &str) -> String;

    /// Return a variable as an owned value expression.
    ///
    /// - Rust: `var.clone()` (String needs explicit cloning)
    /// - JavaScript/Python: `var` (no ownership)
    fn owned_expr(&self, var: &str) -> String {
        var.to_string()
    }

    /// Format a discriminator argument for passing to a templated child.
    ///
    /// Returns an expression computing the disc value from a template.
    /// - `"pct99"` (static) → `'pct99'` (JS) / `"pct99".to_string()` (Rust)
    /// - `""` (empty) → `disc` (pass parent's disc through)
    /// - `"p1sd{disc}"` (suffix) → `_m('p1sd', disc)` (composed)
    /// - `"ratio_{disc}_bps"` (embedded) → `` `ratio_${disc}_bps` `` (template literal)
    fn disc_arg_expr(&self, template: &str) -> String;

    /// Format a templated mode expression: substitute `{disc}` at runtime.
    ///
    /// The template contains `{disc}` placeholder. The generated code should
    /// construct `_m(acc, template_with_disc_substituted)` at runtime.
    ///
    /// # Arguments
    /// * `acc_var` - The accumulator variable (e.g., "acc")
    /// * `template` - Template like `"ratio_{disc}_bps"` or `"{disc}"`
    fn template_expr(&self, acc_var: &str, template: &str) -> String;
}