@codama/renderers-rust

Codama ➤ Renderers ➤ Rust

This package generates Rust clients from your Codama IDLs.

Installation

pnpm install @codama/renderers-rust

[!NOTE] This package is not included in the main codama package.

However, note that the renderers package re-exports the renderVisitor function of this package as renderRustVisitor.

Usage

Once you have a Codama IDL, you can use the renderVisitor of this package to generate Rust clients. You will need to provide the base directory where the generated files will be saved and an optional set of options to customize the output.

// node ./codama.mjs
import { renderVisitor } from '@codama/renderers-rust';

const pathToGeneratedFolder = path.join(__dirname, 'clients', 'rust', 'src', 'generated');
const options = {}; // See below.
codama.accept(renderVisitor(pathToGeneratedFolder, options));

Options

The renderVisitor accepts the following options.

Name	Type	Default	Description
deleteFolderBeforeRendering	boolean	true	Whether the base directory should be cleaned before generating new files.
formatCode	boolean	false	Whether we should use cargo fmt to format the generated code. When set to true, the crateFolder option must be provided.
toolchain	string	"+stable"	The toolchain to use when formatting the generated code.
crateFolder	string	none	The path to the root folder of the Rust crate. This option is required when formatCode is set to true.
linkOverrides	Record<'accounts' | 'definedTypes' | 'instructions' | 'pdas' | 'programs' | 'resolvers', Record<string, string>>	{}	A object that overrides the import path of link nodes. For instance, { definedTypes: { counter: 'hooked' } } uses the hooked folder to import any link node referring to the counter type.
dependencyMap	Record<string, string>	{}	A mapping between import aliases and their actual crate name or path in Rust.
renderParentInstructions	boolean	false	When using nested instructions, whether the parent instructions should also be rendered. When set to false (default), only the instruction leaves are being rendered.