Vlad-Shcherbina / specta

Easily export your Rust types to other languages

Specta

Easily export your Rust types to other languages

Features

• Export structs and enums to Typescript
• Get function types to use in libraries like tauri-specta
• Supports wide range of common crates in Rust ecosystem
• Supports type inference - can determine type of fn demo() -> impl Type.

Ecosystem

Specta can be used in your application either directly or through a library which simplifies the process of using it.

• rspc for easily building end-to-end typesafe APIs
• tauri-specta for typesafe Tauri commands

Usage

Add specta as a dependency to your project, enabling the languages you want to export to:

cargo add specta --features typescript # only 'typescript' is currently supported

Then you can use Specta like so:

use specta::{ts, Type};

#[derive(Type)]
pub struct TypeOne {
    pub a: String,
    pub b: GenericType<i32>,
    #[serde(rename = "cccccc")]
     pub c: MyEnum,
}

#[derive(Type)]
pub struct GenericType<A> {
    pub my_field: String,
    pub generic: A,
}

#[derive(Type)]
pub enum MyEnum {
    A,
    B,
    C,
}

fn main() {
    assert_eq!(
        ts::export::<TypeOne>(&Default::default()).unwrap(),
        "export type TypeOne = { a: string; b: GenericType<number>; cccccc: MyEnum }".to_string()
    );
}

Check out the docs for more information.

Motivation

This library was originally created to power the type exporting functionality of rspc, but after building it we realized that it could be useful for other projects as well so we decided to move it into a dedicated library.

A huge thanks to Brendonovich for doing a heap of development on this library.