# Enum

Em NAPI-RS, o enum do Rust é basicamente transformado em um simples objeto JavaScript.

#[napi]
pub enum Kind {
  Duck,
  Dog,
  Cat,
}

⬇️ ⬇️ ⬇️ ⬇️ ⬇️ ⬇️ ⬇️ ⬇️ ⬇️

export const enum Kind {
  Duck,
  Dog,
  Cat,
}

Em TypeScript, os membros de enums numéricos também recebem um mapeamento reverso dos valores do enum para os nomes do enum. Mas em Rust, não temos esse comportamento de mapeamento reverso. É apenas um objeto JavaScript simples.

As variantes numéricas usam por padrão valores i32 consecutivos a partir de zero. Discriminantes inteiros Rust explícitos são preservados, e variantes implícitas posteriores continuam a partir do valor anterior.

# String enum

#[napi(string_enum)]
pub enum Kind {
  Duck,
  Dog,
  Cat,
}

⬇️ ⬇️ ⬇️ ⬇️ ⬇️ ⬇️ ⬇️ ⬇️ ⬇️

export const enum Kind {
  Duck = 'Duck',
  Dog = 'Dog',
  Cat = 'Cat',
}

Use string_enum = "case" para transformar o nome de todas as variantes ou #[napi(value = "...")] em uma variante para escolher seu valor JavaScript exato. Os cases compatíveis estão listados na referência de atributos #[napi].

#[napi(string_enum = "kebab-case")]
pub enum AccessMode {
  ReadOnly,
  #[napi(value = "read-write")]
  Writable,
}

# Enum estruturado

Um enum com uma variante que contém dados se torna uma união discriminada de objetos, em vez de um objeto enum JavaScript.

#[napi]
pub enum Event {
  Ready,
  FileChanged { path: String },
  Progress(u32, u32),
}

export type Event =
  | { type: 'Ready' }
  | { type: 'FileChanged'; path: string }
  | { type: 'Progress'; field0: number; field1: number }

O discriminador padrão é type. Altere-o com discriminant = "kind" e transforme os valores das variantes com discriminant_case = "camelCase" ou outro case compatível. Campos nomeados de variantes mantêm seus nomes; campos de tupla se tornam field0, field1 e assim por diante. Um campo não pode ter o mesmo nome JavaScript do discriminador.

A conversão de enum estruturado é própria: aceitar um enum lê e converte seus campos em um valor enum Rust, enquanto retorná-lo cria um novo objeto JavaScript. object_from_js = false ou object_to_js = false pode tornar o tipo unidirecional. Consulte Conversões de tipos.

NAPI-RS não suporta a geração de impl de enum Rust em JavaScript.