Struct Generator 

pub struct Generator { /* private fields */ }

TypeScript file generator

Collects types and generates TypeScript definition files.

Implementations

impl Generator

pub fn new(config: Config) -> Self

Create a new generator with the given config

pub fn with_defaults() -> Self

Create a new generator with default config

pub fn register<T: TS>(&mut self) -> &mut Self

Register a type for generation

The type must implement the TS trait (usually via derive). Returns &mut Self for method chaining.

pub fn add(&mut self, typedef: TypeDef) -> &mut Self

Add a TypeDef directly to the registry

Useful when you have a TypeDef from another source.

pub fn registry(&self) -> &TypeRegistry

Get a reference to the internal registry

pub fn registry_mut(&mut self) -> &mut TypeRegistry

Get a mutable reference to the internal registry

pub fn generate(&self) -> String

Generate TypeScript and return as string

pub fn write(&self) -> Result<()>

Generate TypeScript to the configured output file

Errors

Returns an error if:

• No output path is configured
• The file cannot be written

pub fn write_if_changed(&self) -> Result<bool>

Write only if content has changed

Returns Ok(true) if the file was written, Ok(false) if unchanged. This is useful in build.rs to avoid unnecessary rebuilds.

Errors

Returns an error if:

• No output path is configured
• The file cannot be read or written

pub fn types_by_module(&self) -> HashMap<String, Vec<String>>

Group types by their module path

Returns a map from module path to list of type names in that module. Types without a module path are grouped under “default”.

pub fn module_to_path(module: &str) -> PathBuf

Convert a module path to a file path

For example:

• my_crate::models::user -> models/user.ts
• my_crate::api::requests -> api/requests.ts

The crate name is stripped from the beginning.

pub fn generate_for_module(&self, module: &str, type_names: &[String]) -> String

Generate TypeScript content for a specific module

Only includes types from the specified module.

pub fn write_multi_file(&self, output_dir: impl AsRef<Path>) -> Result<usize>

Write TypeScript to multiple files, organized by module

Types are grouped by their module path and written to corresponding files. For example:

• Types from my_crate::models::user go to <output_dir>/models/user.ts
• Types from my_crate::api go to <output_dir>/api.ts

Arguments

• output_dir - Base directory for output files

Returns

Returns the number of files written.

Errors

Returns an error if files cannot be written.

pub fn write_multi_file_if_changed( &self, output_dir: impl AsRef<Path>, ) -> Result<usize>

Write multi-file only if content has changed

Returns the number of files that were written (changed).

Trait Implementations

impl Debug for Generator

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Generator

fn default() -> Self

Returns the “default value” for a type.