struct-record is a procedural macro. It will run at compile time and transform your program's source code.

Adding `struct-record` macro(s) as a dependency

Run this command in a terminal, in your project's directory:

cargo add struct-record

To add it manually, edit your project's Cargo.toml file and add to the [dependencies] section:

struct-record = "0.1.5"

You may need to import the macro(s) with use struct_record::*.

Read the struct_record documentation.

Back to the crate overview.

Readme

struct-record

This is a macro utility to generate struct definitions from enum definitions, in a similar way to Typescript's Record<K, V> type when used with a string union type as K.

Usage

The following enum definition with the macro is more or less analogous to type ExampleEnumToF32 = Record<ExampleEnum, f32>:

#[record(f32, ExampleEnumToF32)]
enum ExampleEnum {
  FooExample,
  BarExample,
  BazExample,
}

const ex: ExampleEnumToF32 = ExampleEnumToF32 {
  foo_example: 1.0,
  bar_example: 2.0,
  baz_example: 3.0,
}

Installation

cargo add struct-record

Adding struct-record macro(s) as a dependency

Adding `struct-record` macro(s) as a dependency