Class RustFileGenerator

Abstract file generator which each file generator much implement.

Hierarchy

RustGenerator
- RustFileGenerator

Implements

AbstractFileGenerator<RustRenderCompleteModelOptions>

Constructors

constructor

new RustFileGenerator(options?): RustFileGenerator
Parameters
- Optional options: {
      constraints?: { enumKey?: EnumKeyConstraint<RustOptions> | undefined; enumValue?: EnumValueConstraint<RustOptions> | undefined; modelName?: ModelNameConstraint<...> | undefined; propertyKey?: PropertyKeyConstraint<...> | undefined; constant?: ConstantConstraint<...> | undefined; };
      defaultPreset?: { struct?: { field?: ((args: PresetArgs<StructRenderer, any, ConstrainedObjectModel> & StructFieldArgs) => string | Promise<...>) | undefined; fieldMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<...>) | undefined; structMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<.....;
      dependencyManager?: (() => AbstractDependencyManager) | ({ dependencies?: (string | undefined)[] | undefined; addDependency?: ((dependency: string) => void) | undefined; });
      indentation?: { type?: IndentationTypes | undefined; size?: number | undefined; };
      presets?: (undefined | ({ struct?: { field?: ((args: PresetArgs<StructRenderer, any, ConstrainedObjectModel> & StructFieldArgs) => string | Promise<...>) | undefined; fieldMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<...>) | undefined; structMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<.....) | ({ preset?: { struct?: { field?: ((args: PresetArgs<StructRenderer, any, ConstrainedObjectModel> & StructFieldArgs) => string | Promise<...>) | undefined; fieldMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<...>) | undefined; structMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string |...))[];
      processorOptions?: { asyncapi?: { source?: string | undefined; applyTraits?: boolean | undefined; parseSchemas?: boolean | undefined; validateOptions?: { allowedSeverity?: { error?: boolean | undefined; warning?: boolean | undefined; info?: boolean | undefined; hint?: boolean | undefined; } | undefined; __unstable?: { ...; } | undefin...;
      typeMapping?: { Object?: TypeMappingFunction<ConstrainedObjectModel, RustOptions, RustDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; };
  }
  - Optional constraints?: { enumKey?: EnumKeyConstraint<RustOptions> | undefined; enumValue?: EnumValueConstraint<RustOptions> | undefined; modelName?: ModelNameConstraint<...> | undefined; propertyKey?: PropertyKeyConstraint<...> | undefined; constant?: ConstantConstraint<...> | undefined; }
  - Optional defaultPreset?: { struct?: { field?: ((args: PresetArgs<StructRenderer, any, ConstrainedObjectModel> & StructFieldArgs) => string | Promise<...>) | undefined; fieldMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<...>) | undefined; structMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<.....
  - Optional dependencyManager?: (() => AbstractDependencyManager) | ({ dependencies?: (string | undefined)[] | undefined; addDependency?: ((dependency: string) => void) | undefined; })
    This dependency manager type serves two functions.
    
    It can be used to provide a factory for generate functions
    
    It can be used to provide a single instance of a dependency manager, to add all dependencies together
    
    This depends on context and where it's used.
  - Optional indentation?: { type?: IndentationTypes | undefined; size?: number | undefined; }
  - Optional presets?: (undefined | ({ struct?: { field?: ((args: PresetArgs<StructRenderer, any, ConstrainedObjectModel> & StructFieldArgs) => string | Promise<...>) | undefined; fieldMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<...>) | undefined; structMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<.....) | ({ preset?: { struct?: { field?: ((args: PresetArgs<StructRenderer, any, ConstrainedObjectModel> & StructFieldArgs) => string | Promise<...>) | undefined; fieldMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<...>) | undefined; structMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string |...))[]
  - Optional processorOptions?: { asyncapi?: { source?: string | undefined; applyTraits?: boolean | undefined; parseSchemas?: boolean | undefined; validateOptions?: { allowedSeverity?: { error?: boolean | undefined; warning?: boolean | undefined; info?: boolean | undefined; hint?: boolean | undefined; } | undefined; __unstable?: { ...; } | undefin...
  - Optional typeMapping?: { Object?: TypeMappingFunction<ConstrainedObjectModel, RustOptions, RustDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; }
Returns RustFileGenerator
Inherited from RustGenerator.constructor
- Defined in src/generators/rust/RustGenerator.ts:118

Properties

`Readonly` languageName

languageName: string

`Readonly` options

options: RustOptions

`Static` defaultOptions

defaultOptions: RustOptions = ...

Methods

constrainToMetaModel

constrainToMetaModel(model, options): ConstrainedMetaModel
Parameters
- model: MetaModel
- options: {
      constraints?: { enumKey?: EnumKeyConstraint<RustOptions> | undefined; enumValue?: EnumValueConstraint<RustOptions> | undefined; modelName?: ModelNameConstraint<...> | undefined; propertyKey?: PropertyKeyConstraint<...> | undefined; constant?: ConstantConstraint<...> | undefined; };
      defaultPreset?: { struct?: { field?: ((args: PresetArgs<StructRenderer, any, ConstrainedObjectModel> & StructFieldArgs) => string | Promise<...>) | undefined; fieldMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<...>) | undefined; structMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<.....;
      dependencyManager?: (() => AbstractDependencyManager) | ({ dependencies?: (string | undefined)[] | undefined; addDependency?: ((dependency: string) => void) | undefined; });
      indentation?: { type?: IndentationTypes | undefined; size?: number | undefined; };
      presets?: (undefined | ({ struct?: { field?: ((args: PresetArgs<StructRenderer, any, ConstrainedObjectModel> & StructFieldArgs) => string | Promise<...>) | undefined; fieldMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<...>) | undefined; structMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<.....) | ({ preset?: { struct?: { field?: ((args: PresetArgs<StructRenderer, any, ConstrainedObjectModel> & StructFieldArgs) => string | Promise<...>) | undefined; fieldMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<...>) | undefined; structMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string |...))[];
      processorOptions?: { asyncapi?: { source?: string | undefined; applyTraits?: boolean | undefined; parseSchemas?: boolean | undefined; validateOptions?: { allowedSeverity?: { error?: boolean | undefined; warning?: boolean | undefined; info?: boolean | undefined; hint?: boolean | undefined; } | undefined; __unstable?: { ...; } | undefin...;
      typeMapping?: { Object?: TypeMappingFunction<ConstrainedObjectModel, RustOptions, RustDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; };
  }
  - Optional constraints?: { enumKey?: EnumKeyConstraint<RustOptions> | undefined; enumValue?: EnumValueConstraint<RustOptions> | undefined; modelName?: ModelNameConstraint<...> | undefined; propertyKey?: PropertyKeyConstraint<...> | undefined; constant?: ConstantConstraint<...> | undefined; }
  - Optional defaultPreset?: { struct?: { field?: ((args: PresetArgs<StructRenderer, any, ConstrainedObjectModel> & StructFieldArgs) => string | Promise<...>) | undefined; fieldMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<...>) | undefined; structMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<.....
  - Optional dependencyManager?: (() => AbstractDependencyManager) | ({ dependencies?: (string | undefined)[] | undefined; addDependency?: ((dependency: string) => void) | undefined; })
    This dependency manager type serves two functions.
    
    It can be used to provide a factory for generate functions
    
    It can be used to provide a single instance of a dependency manager, to add all dependencies together
    
    This depends on context and where it's used.
  - Optional indentation?: { type?: IndentationTypes | undefined; size?: number | undefined; }
  - Optional presets?: (undefined | ({ struct?: { field?: ((args: PresetArgs<StructRenderer, any, ConstrainedObjectModel> & StructFieldArgs) => string | Promise<...>) | undefined; fieldMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<...>) | undefined; structMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<.....) | ({ preset?: { struct?: { field?: ((args: PresetArgs<StructRenderer, any, ConstrainedObjectModel> & StructFieldArgs) => string | Promise<...>) | undefined; fieldMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<...>) | undefined; structMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string |...))[]
  - Optional processorOptions?: { asyncapi?: { source?: string | undefined; applyTraits?: boolean | undefined; parseSchemas?: boolean | undefined; validateOptions?: { allowedSeverity?: { error?: boolean | undefined; warning?: boolean | undefined; info?: boolean | undefined; hint?: boolean | undefined; } | undefined; __unstable?: { ...; } | undefin...
  - Optional typeMapping?: { Object?: TypeMappingFunction<ConstrainedObjectModel, RustOptions, RustDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; }
Returns ConstrainedMetaModel
Inherited from RustGenerator.constrainToMetaModel
- Defined in src/generators/rust/RustGenerator.ts:171

generate

generate(input): Promise<OutputModel[]>
Generates a scattered model where dependencies and rendered results are separated.
Parameters
- input: any
Returns Promise<OutputModel[]>
Inherited from RustGenerator.generate
- Defined in src/generators/AbstractGenerator.ts:228

generateCompleteModels

generateCompleteModels(input, completeOptions): Promise<OutputModel[]>
Generates the full output of a model, instead of a scattered model.

OutputModels result is no longer the model itself, but including package, package dependencies and model dependencies.
Parameters
- input: any
- completeOptions: Partial<RustRenderCompleteModelOptions>
Returns Promise<OutputModel[]>
Inherited from RustGenerator.generateCompleteModels
- Defined in src/generators/AbstractGenerator.ts:198

generateCompleteSupport

generateCompleteSupport(input, completeModelOptions, options?): Promise<OutputModel[]>
Parameters
- input: any
- completeModelOptions: Partial<RustRenderCompleteModelOptions>
- Optional options: {
      constraints?: { enumKey?: EnumKeyConstraint<RustOptions> | undefined; enumValue?: EnumValueConstraint<RustOptions> | undefined; modelName?: ModelNameConstraint<...> | undefined; propertyKey?: PropertyKeyConstraint<...> | undefined; constant?: ConstantConstraint<...> | undefined; };
      defaultPreset?: { struct?: { field?: ((args: PresetArgs<StructRenderer, any, ConstrainedObjectModel> & StructFieldArgs) => string | Promise<...>) | undefined; fieldMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<...>) | undefined; structMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<.....;
      dependencyManager?: (() => AbstractDependencyManager) | ({ dependencies?: (string | undefined)[] | undefined; addDependency?: ((dependency: string) => void) | undefined; });
      indentation?: { type?: IndentationTypes | undefined; size?: number | undefined; };
      presets?: (undefined | ({ struct?: { field?: ((args: PresetArgs<StructRenderer, any, ConstrainedObjectModel> & StructFieldArgs) => string | Promise<...>) | undefined; fieldMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<...>) | undefined; structMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<.....) | ({ preset?: { struct?: { field?: ((args: PresetArgs<StructRenderer, any, ConstrainedObjectModel> & StructFieldArgs) => string | Promise<...>) | undefined; fieldMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<...>) | undefined; structMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string |...))[];
      processorOptions?: { asyncapi?: { source?: string | undefined; applyTraits?: boolean | undefined; parseSchemas?: boolean | undefined; validateOptions?: { allowedSeverity?: { error?: boolean | undefined; warning?: boolean | undefined; info?: boolean | undefined; hint?: boolean | undefined; } | undefined; __unstable?: { ...; } | undefin...;
      typeMapping?: { Object?: TypeMappingFunction<ConstrainedObjectModel, RustOptions, RustDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; };
  }
  - Optional constraints?: { enumKey?: EnumKeyConstraint<RustOptions> | undefined; enumValue?: EnumValueConstraint<RustOptions> | undefined; modelName?: ModelNameConstraint<...> | undefined; propertyKey?: PropertyKeyConstraint<...> | undefined; constant?: ConstantConstraint<...> | undefined; }
  - Optional defaultPreset?: { struct?: { field?: ((args: PresetArgs<StructRenderer, any, ConstrainedObjectModel> & StructFieldArgs) => string | Promise<...>) | undefined; fieldMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<...>) | undefined; structMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<.....
  - Optional dependencyManager?: (() => AbstractDependencyManager) | ({ dependencies?: (string | undefined)[] | undefined; addDependency?: ((dependency: string) => void) | undefined; })
    This dependency manager type serves two functions.
    
    It can be used to provide a factory for generate functions
    
    It can be used to provide a single instance of a dependency manager, to add all dependencies together
    
    This depends on context and where it's used.
  - Optional indentation?: { type?: IndentationTypes | undefined; size?: number | undefined; }
  - Optional presets?: (undefined | ({ struct?: { field?: ((args: PresetArgs<StructRenderer, any, ConstrainedObjectModel> & StructFieldArgs) => string | Promise<...>) | undefined; fieldMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<...>) | undefined; structMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<.....) | ({ preset?: { struct?: { field?: ((args: PresetArgs<StructRenderer, any, ConstrainedObjectModel> & StructFieldArgs) => string | Promise<...>) | undefined; fieldMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<...>) | undefined; structMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string |...))[]
  - Optional processorOptions?: { asyncapi?: { source?: string | undefined; applyTraits?: boolean | undefined; parseSchemas?: boolean | undefined; validateOptions?: { allowedSeverity?: { error?: boolean | undefined; warning?: boolean | undefined; info?: boolean | undefined; hint?: boolean | undefined; } | undefined; __unstable?: { ...; } | undefin...
  - Optional typeMapping?: { Object?: TypeMappingFunction<ConstrainedObjectModel, RustOptions, RustDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; }
Returns Promise<OutputModel[]>
Inherited from RustGenerator.generateCompleteSupport
- Defined in src/generators/rust/RustGenerator.ts:431

generateToFiles

generateToFiles(input, outputDirectory, options, ensureFilesWritten?): Promise<OutputModel[]>
Generates all the models to an output directory each model with their own separate files.
Parameters
- input: any
- outputDirectory: string
  
  where you want the models generated to
- options: RustRenderCompleteModelOptions
- ensureFilesWritten: boolean = false
  
  verify that the files is completely written before returning, this can happen if the file system is swamped with write requests.
Returns Promise<OutputModel[]>
Implementation of AbstractFileGenerator.generateToFiles
- Defined in src/generators/rust/RustFileGenerator.ts:19

generateToPackage

generateToPackage(input, outputDirectory, options, ensureFilesWritten?): Promise<OutputModel[]>
Generates a compile-able package (crate),
Parameters
- input: any
- outputDirectory: string
  
  where you want the models generated to
- options: RustRenderCompleteModelOptions
- ensureFilesWritten: boolean = false
  
  verify that the files is completely written before returning, this can happen if the file system is swamped with write requests.
Returns Promise<OutputModel[]>
- Defined in src/generators/rust/RustFileGenerator.ts:52

getDependencyManager

getDependencyManager(options): RustDependencyManager
Wrapper to get an instance of the dependency manager
Parameters
- options: RustOptions
Returns RustDependencyManager
Inherited from RustGenerator.getDependencyManager
- Defined in src/generators/rust/RustGenerator.ts:155

`Protected` getDependencyManagerInstance

getDependencyManagerInstance(options): AbstractDependencyManager
This function returns an instance of the dependency manager which is either a factory or an instance.
Parameters
- options: RustOptions
Returns AbstractDependencyManager
Inherited from RustGenerator.getDependencyManagerInstance
- Defined in src/generators/AbstractGenerator.ts:106

`Protected` getPresets

getPresets(presetType): [Partial<any>, unknown][]
Get all presets (default and custom ones from options) for a given preset type (class, enum, etc).
Parameters
- presetType: string
Returns [Partial<any>, unknown][]
Inherited from RustGenerator.getPresets
- Defined in src/generators/AbstractGenerator.ts:280

process

process(input): Promise<InputMetaModel>
Parameters
- input: Record<string, unknown>
Returns Promise<InputMetaModel>
Inherited from RustGenerator.process
- Defined in src/generators/AbstractGenerator.ts:96

`Protected` processInput

processInput(input): Promise<InputMetaModel>
Process any of the input formats to the appropriate InputMetaModel type and split out the meta models based on the requirements of the generators
Parameters
- input: any
Returns Promise<InputMetaModel>
Inherited from RustGenerator.processInput
- Defined in src/generators/AbstractGenerator.ts:259

render

render(args): Promise<RenderOutput>
Parameters
- args: AbstractGeneratorRenderArgs<RustOptions, ConstrainedMetaModel>
Returns Promise<RenderOutput>
Inherited from RustGenerator.render
- Defined in src/generators/rust/RustGenerator.ts:192

renderCompleteModel

renderCompleteModel(args): Promise<RenderOutput>
Render a complete model result where the model code, library and model dependencies are all bundled appropriately.
Parameters
- args: AbstractGeneratorRenderCompleteModelArgs<RustOptions, RustRenderCompleteModelOptions>
Returns Promise<RenderOutput>
Inherited from RustGenerator.renderCompleteModel
- Defined in src/generators/rust/RustGenerator.ts:243

renderEnum

renderEnum(model, inputModel, options?): Promise<RenderOutput>
Parameters
- model: ConstrainedEnumModel
- inputModel: InputMetaModel
- Optional options: {
      constraints?: { enumKey?: EnumKeyConstraint<RustOptions> | undefined; enumValue?: EnumValueConstraint<RustOptions> | undefined; modelName?: ModelNameConstraint<...> | undefined; propertyKey?: PropertyKeyConstraint<...> | undefined; constant?: ConstantConstraint<...> | undefined; };
      defaultPreset?: { struct?: { field?: ((args: PresetArgs<StructRenderer, any, ConstrainedObjectModel> & StructFieldArgs) => string | Promise<...>) | undefined; fieldMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<...>) | undefined; structMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<.....;
      dependencyManager?: (() => AbstractDependencyManager) | ({ dependencies?: (string | undefined)[] | undefined; addDependency?: ((dependency: string) => void) | undefined; });
      indentation?: { type?: IndentationTypes | undefined; size?: number | undefined; };
      presets?: (undefined | ({ struct?: { field?: ((args: PresetArgs<StructRenderer, any, ConstrainedObjectModel> & StructFieldArgs) => string | Promise<...>) | undefined; fieldMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<...>) | undefined; structMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<.....) | ({ preset?: { struct?: { field?: ((args: PresetArgs<StructRenderer, any, ConstrainedObjectModel> & StructFieldArgs) => string | Promise<...>) | undefined; fieldMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<...>) | undefined; structMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string |...))[];
      processorOptions?: { asyncapi?: { source?: string | undefined; applyTraits?: boolean | undefined; parseSchemas?: boolean | undefined; validateOptions?: { allowedSeverity?: { error?: boolean | undefined; warning?: boolean | undefined; info?: boolean | undefined; hint?: boolean | undefined; } | undefined; __unstable?: { ...; } | undefin...;
      typeMapping?: { Object?: TypeMappingFunction<ConstrainedObjectModel, RustOptions, RustDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; };
  }
  - Optional constraints?: { enumKey?: EnumKeyConstraint<RustOptions> | undefined; enumValue?: EnumValueConstraint<RustOptions> | undefined; modelName?: ModelNameConstraint<...> | undefined; propertyKey?: PropertyKeyConstraint<...> | undefined; constant?: ConstantConstraint<...> | undefined; }
  - Optional defaultPreset?: { struct?: { field?: ((args: PresetArgs<StructRenderer, any, ConstrainedObjectModel> & StructFieldArgs) => string | Promise<...>) | undefined; fieldMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<...>) | undefined; structMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<.....
  - Optional dependencyManager?: (() => AbstractDependencyManager) | ({ dependencies?: (string | undefined)[] | undefined; addDependency?: ((dependency: string) => void) | undefined; })
    This dependency manager type serves two functions.
    
    It can be used to provide a factory for generate functions
    
    It can be used to provide a single instance of a dependency manager, to add all dependencies together
    
    This depends on context and where it's used.
  - Optional indentation?: { type?: IndentationTypes | undefined; size?: number | undefined; }
  - Optional presets?: (undefined | ({ struct?: { field?: ((args: PresetArgs<StructRenderer, any, ConstrainedObjectModel> & StructFieldArgs) => string | Promise<...>) | undefined; fieldMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<...>) | undefined; structMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<.....) | ({ preset?: { struct?: { field?: ((args: PresetArgs<StructRenderer, any, ConstrainedObjectModel> & StructFieldArgs) => string | Promise<...>) | undefined; fieldMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<...>) | undefined; structMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string |...))[]
  - Optional processorOptions?: { asyncapi?: { source?: string | undefined; applyTraits?: boolean | undefined; parseSchemas?: boolean | undefined; validateOptions?: { allowedSeverity?: { error?: boolean | undefined; warning?: boolean | undefined; info?: boolean | undefined; hint?: boolean | undefined; } | undefined; __unstable?: { ...; } | undefin...
  - Optional typeMapping?: { Object?: TypeMappingFunction<ConstrainedObjectModel, RustOptions, RustDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; }
Returns Promise<RenderOutput>
Inherited from RustGenerator.renderEnum
- Defined in src/generators/rust/RustGenerator.ts:263

renderLib

renderLib(model, inputModel, completeModelOptions, options?): Promise<RenderOutput>
Parameters
- model: ConstrainedMetaModel
- inputModel: InputMetaModel
- completeModelOptions: Partial<RustRenderCompleteModelOptions>
- Optional options: {
      constraints?: { enumKey?: EnumKeyConstraint<RustOptions> | undefined; enumValue?: EnumValueConstraint<RustOptions> | undefined; modelName?: ModelNameConstraint<...> | undefined; propertyKey?: PropertyKeyConstraint<...> | undefined; constant?: ConstantConstraint<...> | undefined; };
      defaultPreset?: { struct?: { field?: ((args: PresetArgs<StructRenderer, any, ConstrainedObjectModel> & StructFieldArgs) => string | Promise<...>) | undefined; fieldMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<...>) | undefined; structMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<.....;
      dependencyManager?: (() => AbstractDependencyManager) | ({ dependencies?: (string | undefined)[] | undefined; addDependency?: ((dependency: string) => void) | undefined; });
      indentation?: { type?: IndentationTypes | undefined; size?: number | undefined; };
      presets?: (undefined | ({ struct?: { field?: ((args: PresetArgs<StructRenderer, any, ConstrainedObjectModel> & StructFieldArgs) => string | Promise<...>) | undefined; fieldMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<...>) | undefined; structMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<.....) | ({ preset?: { struct?: { field?: ((args: PresetArgs<StructRenderer, any, ConstrainedObjectModel> & StructFieldArgs) => string | Promise<...>) | undefined; fieldMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<...>) | undefined; structMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string |...))[];
      processorOptions?: { asyncapi?: { source?: string | undefined; applyTraits?: boolean | undefined; parseSchemas?: boolean | undefined; validateOptions?: { allowedSeverity?: { error?: boolean | undefined; warning?: boolean | undefined; info?: boolean | undefined; hint?: boolean | undefined; } | undefined; __unstable?: { ...; } | undefin...;
      typeMapping?: { Object?: TypeMappingFunction<ConstrainedObjectModel, RustOptions, RustDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; };
  }
  - Optional constraints?: { enumKey?: EnumKeyConstraint<RustOptions> | undefined; enumValue?: EnumValueConstraint<RustOptions> | undefined; modelName?: ModelNameConstraint<...> | undefined; propertyKey?: PropertyKeyConstraint<...> | undefined; constant?: ConstantConstraint<...> | undefined; }
  - Optional defaultPreset?: { struct?: { field?: ((args: PresetArgs<StructRenderer, any, ConstrainedObjectModel> & StructFieldArgs) => string | Promise<...>) | undefined; fieldMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<...>) | undefined; structMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<.....
  - Optional dependencyManager?: (() => AbstractDependencyManager) | ({ dependencies?: (string | undefined)[] | undefined; addDependency?: ((dependency: string) => void) | undefined; })
    This dependency manager type serves two functions.
    
    It can be used to provide a factory for generate functions
    
    It can be used to provide a single instance of a dependency manager, to add all dependencies together
    
    This depends on context and where it's used.
  - Optional indentation?: { type?: IndentationTypes | undefined; size?: number | undefined; }
  - Optional presets?: (undefined | ({ struct?: { field?: ((args: PresetArgs<StructRenderer, any, ConstrainedObjectModel> & StructFieldArgs) => string | Promise<...>) | undefined; fieldMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<...>) | undefined; structMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<.....) | ({ preset?: { struct?: { field?: ((args: PresetArgs<StructRenderer, any, ConstrainedObjectModel> & StructFieldArgs) => string | Promise<...>) | undefined; fieldMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<...>) | undefined; structMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string |...))[]
  - Optional processorOptions?: { asyncapi?: { source?: string | undefined; applyTraits?: boolean | undefined; parseSchemas?: boolean | undefined; validateOptions?: { allowedSeverity?: { error?: boolean | undefined; warning?: boolean | undefined; info?: boolean | undefined; hint?: boolean | undefined; } | undefined; __unstable?: { ...; } | undefin...
  - Optional typeMapping?: { Object?: TypeMappingFunction<ConstrainedObjectModel, RustOptions, RustDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; }
Returns Promise<RenderOutput>
Inherited from RustGenerator.renderLib
- Defined in src/generators/rust/RustGenerator.ts:400

renderManifest

renderManifest(model, inputModel, completeModelOptions, options?): Promise<RenderOutput>
Parameters
- model: ConstrainedMetaModel
- inputModel: InputMetaModel
- completeModelOptions: Partial<RustRenderCompleteModelOptions>
- Optional options: {
      constraints?: { enumKey?: EnumKeyConstraint<RustOptions> | undefined; enumValue?: EnumValueConstraint<RustOptions> | undefined; modelName?: ModelNameConstraint<...> | undefined; propertyKey?: PropertyKeyConstraint<...> | undefined; constant?: ConstantConstraint<...> | undefined; };
      defaultPreset?: { struct?: { field?: ((args: PresetArgs<StructRenderer, any, ConstrainedObjectModel> & StructFieldArgs) => string | Promise<...>) | undefined; fieldMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<...>) | undefined; structMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<.....;
      dependencyManager?: (() => AbstractDependencyManager) | ({ dependencies?: (string | undefined)[] | undefined; addDependency?: ((dependency: string) => void) | undefined; });
      indentation?: { type?: IndentationTypes | undefined; size?: number | undefined; };
      presets?: (undefined | ({ struct?: { field?: ((args: PresetArgs<StructRenderer, any, ConstrainedObjectModel> & StructFieldArgs) => string | Promise<...>) | undefined; fieldMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<...>) | undefined; structMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<.....) | ({ preset?: { struct?: { field?: ((args: PresetArgs<StructRenderer, any, ConstrainedObjectModel> & StructFieldArgs) => string | Promise<...>) | undefined; fieldMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<...>) | undefined; structMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string |...))[];
      processorOptions?: { asyncapi?: { source?: string | undefined; applyTraits?: boolean | undefined; parseSchemas?: boolean | undefined; validateOptions?: { allowedSeverity?: { error?: boolean | undefined; warning?: boolean | undefined; info?: boolean | undefined; hint?: boolean | undefined; } | undefined; __unstable?: { ...; } | undefin...;
      typeMapping?: { Object?: TypeMappingFunction<ConstrainedObjectModel, RustOptions, RustDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; };
  }
  - Optional constraints?: { enumKey?: EnumKeyConstraint<RustOptions> | undefined; enumValue?: EnumValueConstraint<RustOptions> | undefined; modelName?: ModelNameConstraint<...> | undefined; propertyKey?: PropertyKeyConstraint<...> | undefined; constant?: ConstantConstraint<...> | undefined; }
  - Optional defaultPreset?: { struct?: { field?: ((args: PresetArgs<StructRenderer, any, ConstrainedObjectModel> & StructFieldArgs) => string | Promise<...>) | undefined; fieldMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<...>) | undefined; structMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<.....
  - Optional dependencyManager?: (() => AbstractDependencyManager) | ({ dependencies?: (string | undefined)[] | undefined; addDependency?: ((dependency: string) => void) | undefined; })
    This dependency manager type serves two functions.
    
    It can be used to provide a factory for generate functions
    
    It can be used to provide a single instance of a dependency manager, to add all dependencies together
    
    This depends on context and where it's used.
  - Optional indentation?: { type?: IndentationTypes | undefined; size?: number | undefined; }
  - Optional presets?: (undefined | ({ struct?: { field?: ((args: PresetArgs<StructRenderer, any, ConstrainedObjectModel> & StructFieldArgs) => string | Promise<...>) | undefined; fieldMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<...>) | undefined; structMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<.....) | ({ preset?: { struct?: { field?: ((args: PresetArgs<StructRenderer, any, ConstrainedObjectModel> & StructFieldArgs) => string | Promise<...>) | undefined; fieldMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<...>) | undefined; structMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string |...))[]
  - Optional processorOptions?: { asyncapi?: { source?: string | undefined; applyTraits?: boolean | undefined; parseSchemas?: boolean | undefined; validateOptions?: { allowedSeverity?: { error?: boolean | undefined; warning?: boolean | undefined; info?: boolean | undefined; hint?: boolean | undefined; } | undefined; __unstable?: { ...; } | undefin...
  - Optional typeMapping?: { Object?: TypeMappingFunction<ConstrainedObjectModel, RustOptions, RustDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; }
Returns Promise<RenderOutput>
Inherited from RustGenerator.renderManifest
- Defined in src/generators/rust/RustGenerator.ts:370

renderStruct

renderStruct(model, inputModel, options?): Promise<RenderOutput>
Parameters
- model: ConstrainedObjectModel
- inputModel: InputMetaModel
- Optional options: {
      constraints?: { enumKey?: EnumKeyConstraint<RustOptions> | undefined; enumValue?: EnumValueConstraint<RustOptions> | undefined; modelName?: ModelNameConstraint<...> | undefined; propertyKey?: PropertyKeyConstraint<...> | undefined; constant?: ConstantConstraint<...> | undefined; };
      defaultPreset?: { struct?: { field?: ((args: PresetArgs<StructRenderer, any, ConstrainedObjectModel> & StructFieldArgs) => string | Promise<...>) | undefined; fieldMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<...>) | undefined; structMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<.....;
      dependencyManager?: (() => AbstractDependencyManager) | ({ dependencies?: (string | undefined)[] | undefined; addDependency?: ((dependency: string) => void) | undefined; });
      indentation?: { type?: IndentationTypes | undefined; size?: number | undefined; };
      presets?: (undefined | ({ struct?: { field?: ((args: PresetArgs<StructRenderer, any, ConstrainedObjectModel> & StructFieldArgs) => string | Promise<...>) | undefined; fieldMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<...>) | undefined; structMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<.....) | ({ preset?: { struct?: { field?: ((args: PresetArgs<StructRenderer, any, ConstrainedObjectModel> & StructFieldArgs) => string | Promise<...>) | undefined; fieldMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<...>) | undefined; structMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string |...))[];
      processorOptions?: { asyncapi?: { source?: string | undefined; applyTraits?: boolean | undefined; parseSchemas?: boolean | undefined; validateOptions?: { allowedSeverity?: { error?: boolean | undefined; warning?: boolean | undefined; info?: boolean | undefined; hint?: boolean | undefined; } | undefined; __unstable?: { ...; } | undefin...;
      typeMapping?: { Object?: TypeMappingFunction<ConstrainedObjectModel, RustOptions, RustDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; };
  }
  - Optional constraints?: { enumKey?: EnumKeyConstraint<RustOptions> | undefined; enumValue?: EnumValueConstraint<RustOptions> | undefined; modelName?: ModelNameConstraint<...> | undefined; propertyKey?: PropertyKeyConstraint<...> | undefined; constant?: ConstantConstraint<...> | undefined; }
  - Optional defaultPreset?: { struct?: { field?: ((args: PresetArgs<StructRenderer, any, ConstrainedObjectModel> & StructFieldArgs) => string | Promise<...>) | undefined; fieldMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<...>) | undefined; structMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<.....
  - Optional dependencyManager?: (() => AbstractDependencyManager) | ({ dependencies?: (string | undefined)[] | undefined; addDependency?: ((dependency: string) => void) | undefined; })
    This dependency manager type serves two functions.
    
    It can be used to provide a factory for generate functions
    
    It can be used to provide a single instance of a dependency manager, to add all dependencies together
    
    This depends on context and where it's used.
  - Optional indentation?: { type?: IndentationTypes | undefined; size?: number | undefined; }
  - Optional presets?: (undefined | ({ struct?: { field?: ((args: PresetArgs<StructRenderer, any, ConstrainedObjectModel> & StructFieldArgs) => string | Promise<...>) | undefined; fieldMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<...>) | undefined; structMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<.....) | ({ preset?: { struct?: { field?: ((args: PresetArgs<StructRenderer, any, ConstrainedObjectModel> & StructFieldArgs) => string | Promise<...>) | undefined; fieldMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<...>) | undefined; structMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string |...))[]
  - Optional processorOptions?: { asyncapi?: { source?: string | undefined; applyTraits?: boolean | undefined; parseSchemas?: boolean | undefined; validateOptions?: { allowedSeverity?: { error?: boolean | undefined; warning?: boolean | undefined; info?: boolean | undefined; hint?: boolean | undefined; } | undefined; __unstable?: { ...; } | undefin...
  - Optional typeMapping?: { Object?: TypeMappingFunction<ConstrainedObjectModel, RustOptions, RustDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; }
Returns Promise<RenderOutput>
Inherited from RustGenerator.renderStruct
- Defined in src/generators/rust/RustGenerator.ts:290

renderTuple

renderTuple(model, inputModel, options?): Promise<RenderOutput>
Parameters
- model: ConstrainedTupleModel
- inputModel: InputMetaModel
- Optional options: {
      constraints?: { enumKey?: EnumKeyConstraint<RustOptions> | undefined; enumValue?: EnumValueConstraint<RustOptions> | undefined; modelName?: ModelNameConstraint<...> | undefined; propertyKey?: PropertyKeyConstraint<...> | undefined; constant?: ConstantConstraint<...> | undefined; };
      defaultPreset?: { struct?: { field?: ((args: PresetArgs<StructRenderer, any, ConstrainedObjectModel> & StructFieldArgs) => string | Promise<...>) | undefined; fieldMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<...>) | undefined; structMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<.....;
      dependencyManager?: (() => AbstractDependencyManager) | ({ dependencies?: (string | undefined)[] | undefined; addDependency?: ((dependency: string) => void) | undefined; });
      indentation?: { type?: IndentationTypes | undefined; size?: number | undefined; };
      presets?: (undefined | ({ struct?: { field?: ((args: PresetArgs<StructRenderer, any, ConstrainedObjectModel> & StructFieldArgs) => string | Promise<...>) | undefined; fieldMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<...>) | undefined; structMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<.....) | ({ preset?: { struct?: { field?: ((args: PresetArgs<StructRenderer, any, ConstrainedObjectModel> & StructFieldArgs) => string | Promise<...>) | undefined; fieldMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<...>) | undefined; structMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string |...))[];
      processorOptions?: { asyncapi?: { source?: string | undefined; applyTraits?: boolean | undefined; parseSchemas?: boolean | undefined; validateOptions?: { allowedSeverity?: { error?: boolean | undefined; warning?: boolean | undefined; info?: boolean | undefined; hint?: boolean | undefined; } | undefined; __unstable?: { ...; } | undefin...;
      typeMapping?: { Object?: TypeMappingFunction<ConstrainedObjectModel, RustOptions, RustDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; };
  }
  - Optional constraints?: { enumKey?: EnumKeyConstraint<RustOptions> | undefined; enumValue?: EnumValueConstraint<RustOptions> | undefined; modelName?: ModelNameConstraint<...> | undefined; propertyKey?: PropertyKeyConstraint<...> | undefined; constant?: ConstantConstraint<...> | undefined; }
  - Optional defaultPreset?: { struct?: { field?: ((args: PresetArgs<StructRenderer, any, ConstrainedObjectModel> & StructFieldArgs) => string | Promise<...>) | undefined; fieldMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<...>) | undefined; structMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<.....
  - Optional dependencyManager?: (() => AbstractDependencyManager) | ({ dependencies?: (string | undefined)[] | undefined; addDependency?: ((dependency: string) => void) | undefined; })
    This dependency manager type serves two functions.
    
    It can be used to provide a factory for generate functions
    
    It can be used to provide a single instance of a dependency manager, to add all dependencies together
    
    This depends on context and where it's used.
  - Optional indentation?: { type?: IndentationTypes | undefined; size?: number | undefined; }
  - Optional presets?: (undefined | ({ struct?: { field?: ((args: PresetArgs<StructRenderer, any, ConstrainedObjectModel> & StructFieldArgs) => string | Promise<...>) | undefined; fieldMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<...>) | undefined; structMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<.....) | ({ preset?: { struct?: { field?: ((args: PresetArgs<StructRenderer, any, ConstrainedObjectModel> & StructFieldArgs) => string | Promise<...>) | undefined; fieldMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<...>) | undefined; structMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string |...))[]
  - Optional processorOptions?: { asyncapi?: { source?: string | undefined; applyTraits?: boolean | undefined; parseSchemas?: boolean | undefined; validateOptions?: { allowedSeverity?: { error?: boolean | undefined; warning?: boolean | undefined; info?: boolean | undefined; hint?: boolean | undefined; } | undefined; __unstable?: { ...; } | undefin...
  - Optional typeMapping?: { Object?: TypeMappingFunction<ConstrainedObjectModel, RustOptions, RustDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; }
Returns Promise<RenderOutput>
Inherited from RustGenerator.renderTuple
- Defined in src/generators/rust/RustGenerator.ts:317

renderUnion

renderUnion(model, inputModel, options?): Promise<RenderOutput>
Parameters
- model: ConstrainedUnionModel
- inputModel: InputMetaModel
- Optional options: {
      constraints?: { enumKey?: EnumKeyConstraint<RustOptions> | undefined; enumValue?: EnumValueConstraint<RustOptions> | undefined; modelName?: ModelNameConstraint<...> | undefined; propertyKey?: PropertyKeyConstraint<...> | undefined; constant?: ConstantConstraint<...> | undefined; };
      defaultPreset?: { struct?: { field?: ((args: PresetArgs<StructRenderer, any, ConstrainedObjectModel> & StructFieldArgs) => string | Promise<...>) | undefined; fieldMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<...>) | undefined; structMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<.....;
      dependencyManager?: (() => AbstractDependencyManager) | ({ dependencies?: (string | undefined)[] | undefined; addDependency?: ((dependency: string) => void) | undefined; });
      indentation?: { type?: IndentationTypes | undefined; size?: number | undefined; };
      presets?: (undefined | ({ struct?: { field?: ((args: PresetArgs<StructRenderer, any, ConstrainedObjectModel> & StructFieldArgs) => string | Promise<...>) | undefined; fieldMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<...>) | undefined; structMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<.....) | ({ preset?: { struct?: { field?: ((args: PresetArgs<StructRenderer, any, ConstrainedObjectModel> & StructFieldArgs) => string | Promise<...>) | undefined; fieldMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<...>) | undefined; structMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string |...))[];
      processorOptions?: { asyncapi?: { source?: string | undefined; applyTraits?: boolean | undefined; parseSchemas?: boolean | undefined; validateOptions?: { allowedSeverity?: { error?: boolean | undefined; warning?: boolean | undefined; info?: boolean | undefined; hint?: boolean | undefined; } | undefined; __unstable?: { ...; } | undefin...;
      typeMapping?: { Object?: TypeMappingFunction<ConstrainedObjectModel, RustOptions, RustDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; };
  }
  - Optional constraints?: { enumKey?: EnumKeyConstraint<RustOptions> | undefined; enumValue?: EnumValueConstraint<RustOptions> | undefined; modelName?: ModelNameConstraint<...> | undefined; propertyKey?: PropertyKeyConstraint<...> | undefined; constant?: ConstantConstraint<...> | undefined; }
  - Optional defaultPreset?: { struct?: { field?: ((args: PresetArgs<StructRenderer, any, ConstrainedObjectModel> & StructFieldArgs) => string | Promise<...>) | undefined; fieldMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<...>) | undefined; structMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<.....
  - Optional dependencyManager?: (() => AbstractDependencyManager) | ({ dependencies?: (string | undefined)[] | undefined; addDependency?: ((dependency: string) => void) | undefined; })
    This dependency manager type serves two functions.
    
    It can be used to provide a factory for generate functions
    
    It can be used to provide a single instance of a dependency manager, to add all dependencies together
    
    This depends on context and where it's used.
  - Optional indentation?: { type?: IndentationTypes | undefined; size?: number | undefined; }
  - Optional presets?: (undefined | ({ struct?: { field?: ((args: PresetArgs<StructRenderer, any, ConstrainedObjectModel> & StructFieldArgs) => string | Promise<...>) | undefined; fieldMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<...>) | undefined; structMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<.....) | ({ preset?: { struct?: { field?: ((args: PresetArgs<StructRenderer, any, ConstrainedObjectModel> & StructFieldArgs) => string | Promise<...>) | undefined; fieldMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<...>) | undefined; structMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string |...))[]
  - Optional processorOptions?: { asyncapi?: { source?: string | undefined; applyTraits?: boolean | undefined; parseSchemas?: boolean | undefined; validateOptions?: { allowedSeverity?: { error?: boolean | undefined; warning?: boolean | undefined; info?: boolean | undefined; hint?: boolean | undefined; } | undefined; __unstable?: { ...; } | undefin...
  - Optional typeMapping?: { Object?: TypeMappingFunction<ConstrainedObjectModel, RustOptions, RustDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; }
Returns Promise<RenderOutput>
Inherited from RustGenerator.renderUnion
- Defined in src/generators/rust/RustGenerator.ts:344

splitMetaModel

splitMetaModel(model): MetaModel[]
Parameters
- model: MetaModel
Returns MetaModel[]
Inherited from RustGenerator.splitMetaModel
- Defined in src/generators/rust/RustGenerator.ts:159

`Static` getRustCompleteOptions

getRustCompleteOptions(options?): RustRenderCompleteModelOptions
Returns the Rust options by merging custom options with default ones.
Parameters
- Optional options: {
  package?: { packageName?: string | undefined; packageVersion?: string | undefined; authors?: (string | undefined)[] | undefined; homepage?: string | undefined; repository?: string | undefined; license?: string | undefined; description?: string | undefined; edition?: string | undefined; packageFeatures?: (RustPackageFeatures |...;
  supportFiles?: boolean;
  }
  - Optional package?: { packageName?: string | undefined; packageVersion?: string | undefined; authors?: (string | undefined)[] | undefined; homepage?: string | undefined; repository?: string | undefined; license?: string | undefined; description?: string | undefined; edition?: string | undefined; packageFeatures?: (RustPackageFeatures |...
  - Optional supportFiles?: boolean
Returns RustRenderCompleteModelOptions
Inherited from RustGenerator.getRustCompleteOptions
- Defined in src/generators/rust/RustGenerator.ts:143

`Static` getRustOptions

getRustOptions(options?): RustOptions
Returns the Rust options by merging custom options with default ones.
Parameters
- Optional options: {
      constraints?: { enumKey?: EnumKeyConstraint<RustOptions> | undefined; enumValue?: EnumValueConstraint<RustOptions> | undefined; modelName?: ModelNameConstraint<...> | undefined; propertyKey?: PropertyKeyConstraint<...> | undefined; constant?: ConstantConstraint<...> | undefined; };
      defaultPreset?: { struct?: { field?: ((args: PresetArgs<StructRenderer, any, ConstrainedObjectModel> & StructFieldArgs) => string | Promise<...>) | undefined; fieldMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<...>) | undefined; structMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<.....;
      dependencyManager?: (() => AbstractDependencyManager) | ({ dependencies?: (string | undefined)[] | undefined; addDependency?: ((dependency: string) => void) | undefined; });
      indentation?: { type?: IndentationTypes | undefined; size?: number | undefined; };
      presets?: (undefined | ({ struct?: { field?: ((args: PresetArgs<StructRenderer, any, ConstrainedObjectModel> & StructFieldArgs) => string | Promise<...>) | undefined; fieldMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<...>) | undefined; structMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<.....) | ({ preset?: { struct?: { field?: ((args: PresetArgs<StructRenderer, any, ConstrainedObjectModel> & StructFieldArgs) => string | Promise<...>) | undefined; fieldMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<...>) | undefined; structMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string |...))[];
      processorOptions?: { asyncapi?: { source?: string | undefined; applyTraits?: boolean | undefined; parseSchemas?: boolean | undefined; validateOptions?: { allowedSeverity?: { error?: boolean | undefined; warning?: boolean | undefined; info?: boolean | undefined; hint?: boolean | undefined; } | undefined; __unstable?: { ...; } | undefin...;
      typeMapping?: { Object?: TypeMappingFunction<ConstrainedObjectModel, RustOptions, RustDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; };
  }
  - Optional constraints?: { enumKey?: EnumKeyConstraint<RustOptions> | undefined; enumValue?: EnumValueConstraint<RustOptions> | undefined; modelName?: ModelNameConstraint<...> | undefined; propertyKey?: PropertyKeyConstraint<...> | undefined; constant?: ConstantConstraint<...> | undefined; }
  - Optional defaultPreset?: { struct?: { field?: ((args: PresetArgs<StructRenderer, any, ConstrainedObjectModel> & StructFieldArgs) => string | Promise<...>) | undefined; fieldMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<...>) | undefined; structMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<.....
  - Optional dependencyManager?: (() => AbstractDependencyManager) | ({ dependencies?: (string | undefined)[] | undefined; addDependency?: ((dependency: string) => void) | undefined; })
    This dependency manager type serves two functions.
    
    It can be used to provide a factory for generate functions
    
    It can be used to provide a single instance of a dependency manager, to add all dependencies together
    
    This depends on context and where it's used.
  - Optional indentation?: { type?: IndentationTypes | undefined; size?: number | undefined; }
  - Optional presets?: (undefined | ({ struct?: { field?: ((args: PresetArgs<StructRenderer, any, ConstrainedObjectModel> & StructFieldArgs) => string | Promise<...>) | undefined; fieldMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<...>) | undefined; structMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<.....) | ({ preset?: { struct?: { field?: ((args: PresetArgs<StructRenderer, any, ConstrainedObjectModel> & StructFieldArgs) => string | Promise<...>) | undefined; fieldMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string | Promise<...>) | undefined; structMacro?: ((args: PresetArgs<...> & StructFieldArgs) => string |...))[]
  - Optional processorOptions?: { asyncapi?: { source?: string | undefined; applyTraits?: boolean | undefined; parseSchemas?: boolean | undefined; validateOptions?: { allowedSeverity?: { error?: boolean | undefined; warning?: boolean | undefined; info?: boolean | undefined; hint?: boolean | undefined; } | undefined; __unstable?: { ...; } | undefin...
  - Optional typeMapping?: { Object?: TypeMappingFunction<ConstrainedObjectModel, RustOptions, RustDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; }
Returns RustOptions
Inherited from RustGenerator.getRustOptions
- Defined in src/generators/rust/RustGenerator.ts:126

Class RustFileGenerator

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional constraints?: { enumKey?: EnumKeyConstraint<RustOptions> | undefined; enumValue?: EnumValueConstraint<RustOptions> | undefined; modelName?: ModelNameConstraint<...> | undefined; propertyKey?: PropertyKeyConstraint<...> | undefined; constant?: ConstantConstraint<...> | undefined; }

Optional dependencyManager?: (() => AbstractDependencyManager) | ({ dependencies?: (string | undefined)[] | undefined; addDependency?: ((dependency: string) => void) | undefined; })

Optional indentation?: { type?: IndentationTypes | undefined; size?: number | undefined; }

Optional typeMapping?: { Object?: TypeMappingFunction<ConstrainedObjectModel, RustOptions, RustDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; }

Returns RustFileGenerator

Properties

Readonly languageName

Readonly options

Static defaultOptions

Methods

constrainToMetaModel

Parameters

model: MetaModel

Optional constraints?: { enumKey?: EnumKeyConstraint<RustOptions> | undefined; enumValue?: EnumValueConstraint<RustOptions> | undefined; modelName?: ModelNameConstraint<...> | undefined; propertyKey?: PropertyKeyConstraint<...> | undefined; constant?: ConstantConstraint<...> | undefined; }

Optional dependencyManager?: (() => AbstractDependencyManager) | ({ dependencies?: (string | undefined)[] | undefined; addDependency?: ((dependency: string) => void) | undefined; })

Optional indentation?: { type?: IndentationTypes | undefined; size?: number | undefined; }

Optional typeMapping?: { Object?: TypeMappingFunction<ConstrainedObjectModel, RustOptions, RustDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; }

Returns ConstrainedMetaModel

generate

Parameters

input: any

Returns Promise<OutputModel[]>

generateCompleteModels

Parameters

input: any

completeOptions: Partial<RustRenderCompleteModelOptions>

Returns Promise<OutputModel[]>

generateCompleteSupport

Parameters

input: any

completeModelOptions: Partial<RustRenderCompleteModelOptions>

Optional constraints?: { enumKey?: EnumKeyConstraint<RustOptions> | undefined; enumValue?: EnumValueConstraint<RustOptions> | undefined; modelName?: ModelNameConstraint<...> | undefined; propertyKey?: PropertyKeyConstraint<...> | undefined; constant?: ConstantConstraint<...> | undefined; }

Optional dependencyManager?: (() => AbstractDependencyManager) | ({ dependencies?: (string | undefined)[] | undefined; addDependency?: ((dependency: string) => void) | undefined; })

Optional indentation?: { type?: IndentationTypes | undefined; size?: number | undefined; }

Optional typeMapping?: { Object?: TypeMappingFunction<ConstrainedObjectModel, RustOptions, RustDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; }

Returns Promise<OutputModel[]>

generateToFiles

Parameters

input: any

outputDirectory: string

options: RustRenderCompleteModelOptions

ensureFilesWritten: boolean = false

Returns Promise<OutputModel[]>

generateToPackage

Parameters

input: any

outputDirectory: string

options: RustRenderCompleteModelOptions

ensureFilesWritten: boolean = false

Returns Promise<OutputModel[]>

getDependencyManager

Parameters

options: RustOptions

Returns RustDependencyManager

Protected getDependencyManagerInstance

Parameters

options: RustOptions

Returns AbstractDependencyManager

Protected getPresets

Parameters

presetType: string

Returns [Partial<any>, unknown][]

process

Parameters

input: Record<string, unknown>

Returns Promise<InputMetaModel>

Protected processInput

Parameters

input: any

Returns Promise<InputMetaModel>

`Optional` constraints?: { enumKey?: EnumKeyConstraint<RustOptions> | undefined; enumValue?: EnumValueConstraint<RustOptions> | undefined; modelName?: ModelNameConstraint<...> | undefined; propertyKey?: PropertyKeyConstraint<...> | undefined; constant?: ConstantConstraint<...> | undefined; }

`Optional` dependencyManager?: (() => AbstractDependencyManager) | ({ dependencies?: (string | undefined)[] | undefined; addDependency?: ((dependency: string) => void) | undefined; })

`Optional` indentation?: { type?: IndentationTypes | undefined; size?: number | undefined; }

`Optional` typeMapping?: { Object?: TypeMappingFunction<ConstrainedObjectModel, RustOptions, RustDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; }

`Readonly` languageName

`Readonly` options

`Static` defaultOptions

`Optional` constraints?: { enumKey?: EnumKeyConstraint<RustOptions> | undefined; enumValue?: EnumValueConstraint<RustOptions> | undefined; modelName?: ModelNameConstraint<...> | undefined; propertyKey?: PropertyKeyConstraint<...> | undefined; constant?: ConstantConstraint<...> | undefined; }

`Optional` dependencyManager?: (() => AbstractDependencyManager) | ({ dependencies?: (string | undefined)[] | undefined; addDependency?: ((dependency: string) => void) | undefined; })

`Optional` indentation?: { type?: IndentationTypes | undefined; size?: number | undefined; }

`Optional` typeMapping?: { Object?: TypeMappingFunction<ConstrainedObjectModel, RustOptions, RustDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; }

`Optional` constraints?: { enumKey?: EnumKeyConstraint<RustOptions> | undefined; enumValue?: EnumValueConstraint<RustOptions> | undefined; modelName?: ModelNameConstraint<...> | undefined; propertyKey?: PropertyKeyConstraint<...> | undefined; constant?: ConstantConstraint<...> | undefined; }

`Optional` dependencyManager?: (() => AbstractDependencyManager) | ({ dependencies?: (string | undefined)[] | undefined; addDependency?: ((dependency: string) => void) | undefined; })

`Optional` indentation?: { type?: IndentationTypes | undefined; size?: number | undefined; }

`Optional` typeMapping?: { Object?: TypeMappingFunction<ConstrainedObjectModel, RustOptions, RustDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; }

`Protected` getDependencyManagerInstance

`Protected` getPresets

`Protected` processInput

`Optional` constraints?: { enumKey?: EnumKeyConstraint<RustOptions> | undefined; enumValue?: EnumValueConstraint<RustOptions> | undefined; modelName?: ModelNameConstraint<...> | undefined; propertyKey?: PropertyKeyConstraint<...> | undefined; constant?: ConstantConstraint<...> | undefined; }

`Optional` dependencyManager?: (() => AbstractDependencyManager) | ({ dependencies?: (string | undefined)[] | undefined; addDependency?: ((dependency: string) => void) | undefined; })

`Optional` indentation?: { type?: IndentationTypes | undefined; size?: number | undefined; }

`Optional` typeMapping?: { Object?: TypeMappingFunction<ConstrainedObjectModel, RustOptions, RustDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; }

`Optional` constraints?: { enumKey?: EnumKeyConstraint<RustOptions> | undefined; enumValue?: EnumValueConstraint<RustOptions> | undefined; modelName?: ModelNameConstraint<...> | undefined; propertyKey?: PropertyKeyConstraint<...> | undefined; constant?: ConstantConstraint<...> | undefined; }

`Optional` dependencyManager?: (() => AbstractDependencyManager) | ({ dependencies?: (string | undefined)[] | undefined; addDependency?: ((dependency: string) => void) | undefined; })

`Optional` indentation?: { type?: IndentationTypes | undefined; size?: number | undefined; }

`Optional` typeMapping?: { Object?: TypeMappingFunction<ConstrainedObjectModel, RustOptions, RustDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; }

`Optional` constraints?: { enumKey?: EnumKeyConstraint<RustOptions> | undefined; enumValue?: EnumValueConstraint<RustOptions> | undefined; modelName?: ModelNameConstraint<...> | undefined; propertyKey?: PropertyKeyConstraint<...> | undefined; constant?: ConstantConstraint<...> | undefined; }

`Optional` dependencyManager?: (() => AbstractDependencyManager) | ({ dependencies?: (string | undefined)[] | undefined; addDependency?: ((dependency: string) => void) | undefined; })

`Optional` indentation?: { type?: IndentationTypes | undefined; size?: number | undefined; }

`Optional` typeMapping?: { Object?: TypeMappingFunction<ConstrainedObjectModel, RustOptions, RustDependencyManager> | undefined; ... 10 more ...; Dictionary?: TypeMappingFunction<...> | undefined; }

`Optional` constraints?: { enumKey?: EnumKeyConstraint<RustOptions> | undefined; enumValue?: EnumValueConstraint<RustOptions> | undefined; modelName?: ModelNameConstraint<...> | undefined; propertyKey?: PropertyKeyConstraint<...> | undefined; constant?: ConstantConstraint<...> | undefined; }

`Optional` dependencyManager?: (() => AbstractDependencyManager) | ({ dependencies?: (string | undefined)[] | undefined; addDependency?: ((dependency: string) => void) | undefined; })

`Optional` indentation?: { type?: IndentationTypes | undefined; size?: number | undefined; }