Trait ts_rs::TS

pub trait TS: 'static {
    pub fn name() -> String;
    pub fn dependencies() -> Vec<(TypeId, String)>;

    pub fn decl() -> String { ... }
    pub fn inline(indent: usize) -> String { ... }
    pub fn inline_flattened(indent: usize) -> String { ... }
    pub fn dump(out: impl AsRef<Path>) -> Result<()> { ... }
}

A type which can be represented in TypeScript.
Most of the time, you'd want to derive this trait instead of implementing it manually.
ts-rs comes with implementations for all numeric types, String, Vec, Option and tuples.

get started

TS can easily be derived for structs and enums:

use ts_rs::TS;

#[derive(TS)]
struct User {
    first_name: String,
    last_name: String,
}

To actually obtain the bindings, you can call User::dump to write the bindings to a file:

std::fs::remove_file("bindings.ts").ok();
User::dump("bindings.ts").unwrap();

struct attributes

• #[ts(rename = "..")]:
  Set the name of the generated interface

• #[ts(rename_all = "..")]:
  Rename all fields of this struct.
  Valid values are lowercase, UPPERCASE, camelCase, snake_case, PascalCase, SCREAMING_SNAKE_CASE

struct field attributes

• #[ts(type = "..")]:
  Overrides the type used in TypeScript

• #[ts(rename = "..")]:
  Renames this field

• #[ts(inline)]:
  Inlines the type of this field

• #[ts(skip)]:
  Skip this field

• #[ts(flatten)]:
  Flatten this field (only works if the field is a struct)

enum attributes

• #[ts(rename = "..")]:
  Set the name of the generated type

• #[ts(rename_all = "..")]:
  Rename all variants of this enum.
  Valid values are lowercase, UPPERCASE, camelCase, snake_case, PascalCase, SCREAMING_SNAKE_CASE

enum variant attributes

• #[ts(rename = "..")]:
  Renames this variant

• #[ts(skip)]:
  Skip this variant

Required methods

pub fn name() -> String

Name of this type in TypeScript.

pub fn dependencies() -> Vec<(TypeId, String)>

All type ids and typescript names of the types this type depends on.
This is used for resolving imports when using the export! macro.

Loading content...

Provided methods

pub fn decl() -> String

Declaration of this type, e.g. interface User { user_id: number, ... }. This function will panic if the type has no declaration.

pub fn inline(indent: usize) -> String

Formats this types definition in TypeScript, e.g { user_id: number }. This function will panic if the type cannot be inlined.

pub fn inline_flattened(indent: usize) -> String

Flatten an type declaration.
This function will panic if the type cannot be flattened.

pub fn dump(out: impl AsRef<Path>) -> Result<()>

Dumps the declaration of this type to a file.
If the file does not exist, it will be created.
If it does, the declaration will be appended.

This function will panicked when called on a type which does not have a declaration.

Loading content...

Implementations on Foreign Types

impl TS for u8

pub fn name() -> String

pub fn inline(_: usize) -> String

pub fn dependencies() -> Vec<(TypeId, String)>

impl TS for i8

pub fn name() -> String

pub fn inline(_: usize) -> String

pub fn dependencies() -> Vec<(TypeId, String)>

impl TS for u16

pub fn name() -> String

pub fn inline(_: usize) -> String

pub fn dependencies() -> Vec<(TypeId, String)>

impl TS for i16

pub fn name() -> String

pub fn inline(_: usize) -> String

pub fn dependencies() -> Vec<(TypeId, String)>

impl TS for u32

pub fn name() -> String

pub fn inline(_: usize) -> String

pub fn dependencies() -> Vec<(TypeId, String)>

impl TS for i32

pub fn name() -> String

pub fn inline(_: usize) -> String

pub fn dependencies() -> Vec<(TypeId, String)>

impl TS for u64

pub fn name() -> String

pub fn inline(_: usize) -> String

pub fn dependencies() -> Vec<(TypeId, String)>

impl TS for i64

pub fn name() -> String

pub fn inline(_: usize) -> String

pub fn dependencies() -> Vec<(TypeId, String)>

impl TS for f32

pub fn name() -> String

pub fn inline(_: usize) -> String

pub fn dependencies() -> Vec<(TypeId, String)>

impl TS for f64

pub fn name() -> String

pub fn inline(_: usize) -> String

pub fn dependencies() -> Vec<(TypeId, String)>

impl TS for u128

pub fn name() -> String

pub fn inline(_: usize) -> String

pub fn dependencies() -> Vec<(TypeId, String)>

impl TS for i128

pub fn name() -> String

pub fn inline(_: usize) -> String

pub fn dependencies() -> Vec<(TypeId, String)>

impl TS for bool

pub fn name() -> String

pub fn inline(_: usize) -> String

pub fn dependencies() -> Vec<(TypeId, String)>

impl TS for String

pub fn name() -> String

pub fn inline(_: usize) -> String

pub fn dependencies() -> Vec<(TypeId, String)>

impl TS for &'static str

pub fn name() -> String

pub fn inline(_: usize) -> String

pub fn dependencies() -> Vec<(TypeId, String)>

impl TS for ()

pub fn name() -> String

pub fn inline(_: usize) -> String

pub fn dependencies() -> Vec<(TypeId, String)>

impl<T1: TS, T2: TS, T3: TS, T4: TS, T5: TS, T6: TS, T7: TS, T8: TS, T9: TS, T10: TS> TS for (T1, T2, T3, T4, T5, T6, T7, T8, T9, T10)

pub fn name() -> String

pub fn inline(indent: usize) -> String

pub fn dependencies() -> Vec<(TypeId, String)>

impl<T2: TS, T3: TS, T4: TS, T5: TS, T6: TS, T7: TS, T8: TS, T9: TS, T10: TS> TS for (T2, T3, T4, T5, T6, T7, T8, T9, T10)

pub fn name() -> String

pub fn inline(indent: usize) -> String

pub fn dependencies() -> Vec<(TypeId, String)>

impl<T3: TS, T4: TS, T5: TS, T6: TS, T7: TS, T8: TS, T9: TS, T10: TS> TS for (T3, T4, T5, T6, T7, T8, T9, T10)

pub fn name() -> String

pub fn inline(indent: usize) -> String

pub fn dependencies() -> Vec<(TypeId, String)>

impl<T4: TS, T5: TS, T6: TS, T7: TS, T8: TS, T9: TS, T10: TS> TS for (T4, T5, T6, T7, T8, T9, T10)

pub fn name() -> String

pub fn inline(indent: usize) -> String

pub fn dependencies() -> Vec<(TypeId, String)>

impl<T5: TS, T6: TS, T7: TS, T8: TS, T9: TS, T10: TS> TS for (T5, T6, T7, T8, T9, T10)

pub fn name() -> String

pub fn inline(indent: usize) -> String

pub fn dependencies() -> Vec<(TypeId, String)>

impl<T6: TS, T7: TS, T8: TS, T9: TS, T10: TS> TS for (T6, T7, T8, T9, T10)

pub fn name() -> String

pub fn inline(indent: usize) -> String

pub fn dependencies() -> Vec<(TypeId, String)>

impl<T7: TS, T8: TS, T9: TS, T10: TS> TS for (T7, T8, T9, T10)

pub fn name() -> String

pub fn inline(indent: usize) -> String

pub fn dependencies() -> Vec<(TypeId, String)>

impl<T8: TS, T9: TS, T10: TS> TS for (T8, T9, T10)

pub fn name() -> String

pub fn inline(indent: usize) -> String

pub fn dependencies() -> Vec<(TypeId, String)>

impl<T9: TS, T10: TS> TS for (T9, T10)

pub fn name() -> String

pub fn inline(indent: usize) -> String

pub fn dependencies() -> Vec<(TypeId, String)>

impl<T10: TS> TS for (T10,)

pub fn name() -> String

pub fn inline(indent: usize) -> String

pub fn dependencies() -> Vec<(TypeId, String)>

impl<T: TS> TS for Box<T>

pub fn name() -> String

pub fn inline(indent: usize) -> String

pub fn inline_flattened(indent: usize) -> String

pub fn dependencies() -> Vec<(TypeId, String)>

impl<T: TS> TS for Arc<T>

pub fn name() -> String

pub fn inline(indent: usize) -> String

pub fn inline_flattened(indent: usize) -> String

pub fn dependencies() -> Vec<(TypeId, String)>

impl<T: TS> TS for Rc<T>

pub fn name() -> String

pub fn inline(indent: usize) -> String

pub fn inline_flattened(indent: usize) -> String

pub fn dependencies() -> Vec<(TypeId, String)>

impl<T: TS + ToOwned> TS for Cow<'static, T>

pub fn name() -> String

pub fn inline(indent: usize) -> String

pub fn inline_flattened(indent: usize) -> String

pub fn dependencies() -> Vec<(TypeId, String)>

impl<T: TS> TS for Cell<T>

pub fn name() -> String

pub fn inline(indent: usize) -> String

pub fn inline_flattened(indent: usize) -> String

pub fn dependencies() -> Vec<(TypeId, String)>

impl<T: TS> TS for RefCell<T>

pub fn name() -> String

pub fn inline(indent: usize) -> String

pub fn inline_flattened(indent: usize) -> String

pub fn dependencies() -> Vec<(TypeId, String)>

impl<T: TS> TS for Option<T>

pub fn name() -> String

pub fn inline(indent: usize) -> String

pub fn dependencies() -> Vec<(TypeId, String)>

impl<T: TS> TS for Vec<T>

pub fn name() -> String

pub fn inline(indent: usize) -> String

pub fn dependencies() -> Vec<(TypeId, String)>

Loading content...

Implementors

Loading content...