feat(rust): support ability to disable boxed models in client (#17931)

* feat(client): support ability to disable boxed models

Add new additional property `avoidBoxedModels` which can be configured to avoid `Box<..>` of models.

It's very nice to have such config, because it doesn't make a lot of sense for really simple models.

* test: rollback config of existed test

Author: DDtKey

bin/configs/rust-hyper-oneOf.yaml

@@ -4,5 +4,5 @@ library: hyper
 inputSpec: modules/openapi-generator/src/test/resources/3_0/oneof_polymorphism_and_inheritance.yaml
 templateDir: modules/openapi-generator/src/main/resources/rust
 additionalProperties:
-  supportAsync: "false"
+  supportAsync: false
   packageName: oneof-hyper

bin/configs/rust-reqwest-petstore-avoid-box.yaml

@@ -0,0 +1,11 @@
+generatorName: rust
+outputDir: samples/client/petstore/rust/reqwest/petstore-avoid-box
+library: reqwest
+inputSpec: modules/openapi-generator/src/test/resources/3_0/rust/petstore.yaml
+templateDir: modules/openapi-generator/src/main/resources/rust
+additionalProperties:
+  supportAsync: true
+  supportMultipleResponses: true
+  avoidBoxedModels: true
+  packageName: petstore-reqwest-avoid-box
+  useSingleRequestParameter: true

docs/generators/rust.md

@@ -18,6 +18,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 
 | Option | Description | Values | Default |
 | ------ | ----------- | ------ | ------- |
+|avoidBoxedModels|If set, `Box<T>` will not be used for models| |false|
 |bestFitInt|Use best fitting integer type where minimum or maximum is set| |false|
 |enumNameSuffix|Suffix that will be appended to all enum names.| ||
 |hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |true|

modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/RustClientCodegen.java

@@ -50,6 +50,7 @@ public class RustClientCodegen extends AbstractRustCodegen implements CodegenCon
     private boolean withAWSV4Signature = false;
     private boolean preferUnsignedInt = false;
     private boolean bestFitInt = false;
+    private boolean avoidBoxedModels = false;
 
     public static final String PACKAGE_NAME = "packageName";
     public static final String PACKAGE_VERSION = "packageVersion";
@@ -60,6 +61,7 @@ public class RustClientCodegen extends AbstractRustCodegen implements CodegenCon
     public static final String SUPPORT_MULTIPLE_RESPONSES = "supportMultipleResponses";
     public static final String PREFER_UNSIGNED_INT = "preferUnsignedInt";
     public static final String BEST_FIT_INT = "bestFitInt";
+    public static final String AVOID_BOXED_MODELS = "avoidBoxedModels";
 
     protected String packageName = "openapi";
     protected String packageVersion = "1.0.0";
@@ -192,6 +194,8 @@ public RustClientCodegen() {
                 .defaultValue(Boolean.FALSE.toString()));
         cliOptions.add(new CliOption(BEST_FIT_INT, "Use best fitting integer type where minimum or maximum is set", SchemaTypeUtil.BOOLEAN_TYPE)
                 .defaultValue(Boolean.FALSE.toString()));
+        cliOptions.add(new CliOption(AVOID_BOXED_MODELS, "If set, `Box<T>` will not be used for models", SchemaTypeUtil.BOOLEAN_TYPE)
+                .defaultValue(Boolean.FALSE.toString()));
 
         supportedLibraries.put(HYPER_LIBRARY, "HTTP client: Hyper.");
         supportedLibraries.put(REQWEST_LIBRARY, "HTTP client: Reqwest.");
@@ -341,6 +345,11 @@ public void processOpts() {
         }
         writePropertyBack(BEST_FIT_INT, getBestFitInt());
 
+        if (additionalProperties.containsKey(AVOID_BOXED_MODELS)) {
+            this.setAvoidBoxedModels(convertPropertyToBoolean(AVOID_BOXED_MODELS));
+        }
+        writePropertyBack(AVOID_BOXED_MODELS, getAvoidBoxedModels());
+
         additionalProperties.put(CodegenConstants.PACKAGE_NAME, packageName);
         additionalProperties.put(CodegenConstants.PACKAGE_VERSION, packageVersion);
 
@@ -437,6 +446,14 @@ private void setUseSingleRequestParameter(boolean useSingleRequestParameter) {
         this.useSingleRequestParameter = useSingleRequestParameter;
     }
 
+    public boolean getAvoidBoxedModels() {
+        return avoidBoxedModels;
+    }
+
+    public void setAvoidBoxedModels(boolean avoidBoxedModels) {
+        this.avoidBoxedModels = avoidBoxedModels;
+    }
+
     @Override
     public String apiFileFolder() {
         return (outputFolder + File.separator + apiFolder).replace("/", File.separator);
@@ -602,5 +619,4 @@ public String toDefaultValue(Schema p) {
             return null;
         }
     }
-
 }

modules/openapi-generator/src/main/resources/rust/model.mustache

@@ -52,7 +52,7 @@ pub enum {{{classname}}} {
         /// {{{.}}}
         {{/description}}
         #[serde(rename = "{{{baseName}}}"{{^required}}, skip_serializing_if = "Option::is_none"{{/required}})]
-        {{{name}}}: {{#required}}{{#isNullable}}Option<{{/isNullable}}{{/required}}{{^required}}Option<{{/required}}{{#isEnum}}{{{enumName}}}{{/isEnum}}{{^isEnum}}{{#isModel}}Box<{{{dataType}}}>{{/isModel}}{{^isModel}}{{{dataType}}}{{/isModel}}{{/isEnum}}{{#required}}{{#isNullable}}>{{/isNullable}}{{/required}}{{^required}}>{{/required}},
+        {{{name}}}: {{#required}}{{#isNullable}}Option<{{/isNullable}}{{/required}}{{^required}}Option<{{/required}}{{#isEnum}}{{{enumName}}}{{/isEnum}}{{^isEnum}}{{#isModel}}{{^avoidBoxedModels}}Box<{{/avoidBoxedModels}}{{{dataType}}}{{^avoidBoxedModels}}>{{/avoidBoxedModels}}{{/isModel}}{{^isModel}}{{{dataType}}}{{/isModel}}{{/isEnum}}{{#required}}{{#isNullable}}>{{/isNullable}}{{/required}}{{^required}}>{{/required}},
     {{/vars}}
     },
     {{/mappedModels}}
@@ -65,7 +65,7 @@ pub enum {{{classname}}} {
     {{#baseName}}
     #[serde(rename="{{{.}}}")]
     {{/baseName}}
-    {{{name}}}(Box<{{{dataType}}}>),
+    {{{name}}}({{#isModel}}{{^avoidBoxedModels}}Box<{{/avoidBoxedModels}}{{/isModel}}{{{dataType}}}{{#isModel}}{{^avoidBoxedModels}}>{{/avoidBoxedModels}}{{/isModel}}),
     {{/composedSchemas.oneOf}}
     {{/oneOf.isEmpty}}
 }
@@ -77,7 +77,7 @@ impl Default for {{classname}} {
             {{{name}}}: Default::default(),
         {{/vars}}
         }{{/-first}}{{/mappedModels}}
-        {{/oneOf}}{{^oneOf.isEmpty}}{{#composedSchemas.oneOf}}{{#-first}}Self::{{{name}}}(Box::default()){{/-first}}{{/composedSchemas.oneOf}}{{/oneOf.isEmpty}}
+        {{/oneOf}}{{^oneOf.isEmpty}}{{#composedSchemas.oneOf}}{{#-first}}Self::{{{name}}}(Default::default()){{/-first}}{{/composedSchemas.oneOf}}{{/oneOf.isEmpty}}
     }
 }
 
@@ -93,7 +93,7 @@ pub struct {{{classname}}} {
     /// {{{.}}}
     {{/description}}
     #[serde(rename = "{{{baseName}}}"{{^required}}{{#isNullable}}, default, with = "::serde_with::rust::double_option"{{/isNullable}}{{/required}}{{^required}}, skip_serializing_if = "Option::is_none"{{/required}}{{#required}}{{#isNullable}}, deserialize_with = "Option::deserialize"{{/isNullable}}{{/required}})]
-    pub {{{name}}}: {{#isNullable}}Option<{{/isNullable}}{{^required}}Option<{{/required}}{{#isEnum}}{{#isArray}}{{#uniqueItems}}std::collections::HashSet<{{/uniqueItems}}{{^uniqueItems}}Vec<{{/uniqueItems}}{{/isArray}}{{{enumName}}}{{#isArray}}>{{/isArray}}{{/isEnum}}{{^isEnum}}{{#isModel}}Box<{{{dataType}}}>{{/isModel}}{{^isModel}}{{{dataType}}}{{/isModel}}{{/isEnum}}{{#isNullable}}>{{/isNullable}}{{^required}}>{{/required}},
+    pub {{{name}}}: {{#isNullable}}Option<{{/isNullable}}{{^required}}Option<{{/required}}{{#isEnum}}{{#isArray}}{{#uniqueItems}}std::collections::HashSet<{{/uniqueItems}}{{^uniqueItems}}Vec<{{/uniqueItems}}{{/isArray}}{{{enumName}}}{{#isArray}}>{{/isArray}}{{/isEnum}}{{^isEnum}}{{#isModel}}{{^avoidBoxedModels}}Box<{{/avoidBoxedModels}}{{{dataType}}}{{^avoidBoxedModels}}>{{/avoidBoxedModels}}{{/isModel}}{{^isModel}}{{{dataType}}}{{/isModel}}{{/isEnum}}{{#isNullable}}>{{/isNullable}}{{^required}}>{{/required}},
 {{/vars}}
 }
 
@@ -104,7 +104,7 @@ impl {{{classname}}} {
     pub fn new({{#requiredVars}}{{{name}}}: {{#isNullable}}Option<{{/isNullable}}{{#isEnum}}{{#isArray}}{{#uniqueItems}}std::collections::HashSet<{{/uniqueItems}}{{^uniqueItems}}Vec<{{/uniqueItems}}{{/isArray}}{{{enumName}}}{{#isArray}}>{{/isArray}}{{/isEnum}}{{^isEnum}}{{{dataType}}}{{/isEnum}}{{#isNullable}}>{{/isNullable}}{{^-last}}, {{/-last}}{{/requiredVars}}) -> {{{classname}}} {
         {{{classname}}} {
             {{#vars}}
-            {{{name}}}{{^required}}: None{{/required}}{{#required}}{{#isModel}}: {{^isNullable}}Box::new({{{name}}}){{/isNullable}}{{#isNullable}}if let Some(x) = {{{name}}} {Some(Box::new(x))} else {None}{{/isNullable}}{{/isModel}}{{/required}},
+            {{{name}}}{{^required}}: None{{/required}}{{#required}}{{#isModel}}{{^avoidBoxedModels}}: {{^isNullable}}Box::new({{{name}}}){{/isNullable}}{{#isNullable}}if let Some(x) = {{{name}}} {Some(Box::new(x))} else {None}{{/isNullable}}{{/avoidBoxedModels}}{{/isModel}}{{/required}},
             {{/vars}}
         }
     }
@@ -122,13 +122,13 @@ pub enum {{classname}} {
     {{#description}}
     /// {{{.}}}
     {{/description}}
-    {{{name}}}(Box<{{{dataType}}}>),
+    {{{name}}}({{#isModel}}{{^avoidBoxedModels}}Box<{{/avoidBoxedModels}}{{/isModel}}{{{dataType}}}{{#isModel}}{{^avoidBoxedModels}}>{{/avoidBoxedModels}}{{/isModel}}),
 {{/composedSchemas.oneOf}}
 }
 
 impl Default for {{classname}} {
     fn default() -> Self {
-        {{#composedSchemas.oneOf}}{{#-first}}Self::{{{name}}}(Box::default()){{/-first}}{{/composedSchemas.oneOf}}
+        {{#composedSchemas.oneOf}}{{#-first}}Self::{{{name}}}(Default::default()){{/-first}}{{/composedSchemas.oneOf}}
     }
 }
 {{/oneOf.isEmpty}}

modules/openapi-generator/src/test/java/org/openapitools/codegen/rust/RustClientCodegenTest.java

@@ -48,6 +48,7 @@ public void testSettersForConfigValues() throws Exception {
         codegen.setHideGenerationTimestamp(false);
         codegen.setPreferUnsignedInt(true);
         codegen.setBestFitInt(true);
+        codegen.setAvoidBoxedModels(true);
         codegen.processOpts();
 
         Assert.assertEquals(codegen.additionalProperties().get(CodegenConstants.HIDE_GENERATION_TIMESTAMP), Boolean.FALSE);
@@ -58,6 +59,9 @@ public void testSettersForConfigValues() throws Exception {
 
         Assert.assertEquals(codegen.additionalProperties().get(RustClientCodegen.BEST_FIT_INT), Boolean.TRUE);
         Assert.assertTrue(codegen.getBestFitInt());
+
+        Assert.assertEquals(codegen.additionalProperties().get(RustClientCodegen.AVOID_BOXED_MODELS), Boolean.TRUE);
+        Assert.assertTrue(codegen.getAvoidBoxedModels());
     }
 
     @Test

samples/client/others/rust/hyper/composed-oneof/src/models/create_state_request.rs

@@ -21,7 +21,7 @@ pub enum CreateStateRequest {
 
 impl Default for CreateStateRequest {
     fn default() -> Self {
-        Self::AType(Box::default())
+        Self::AType(Default::default())
     }
 }
 

samples/client/others/rust/hyper/composed-oneof/src/models/custom_one_of_array_schema_inner.rs

@@ -23,7 +23,7 @@ pub enum CustomOneOfArraySchemaInner {
 
 impl Default for CustomOneOfArraySchemaInner {
     fn default() -> Self {
-        Self::AType(Box::default())
+        Self::AType(Default::default())
     }
 }
 

samples/client/others/rust/hyper/composed-oneof/src/models/custom_one_of_schema.rs

@@ -21,7 +21,7 @@ pub enum CustomOneOfSchema {
 
 impl Default for CustomOneOfSchema {
     fn default() -> Self {
-        Self::AType(Box::default())
+        Self::AType(Default::default())
     }
 }
 

samples/client/others/rust/hyper/composed-oneof/src/models/get_state_200_response.rs

@@ -23,7 +23,7 @@ pub enum GetState200Response {
 
 impl Default for GetState200Response {
     fn default() -> Self {
-        Self::AType(Box::default())
+        Self::AType(Default::default())
     }
 }