Trait Tsify

pub trait Tsify {
    type JsType: JsCast;

    const DECL: &'static str;
    const SERIALIZATION_CONFIG: SerializationConfig = _;

    // Provided methods
    fn into_js(&self) -> Result<Self::JsType, Error>
       where Self: Serialize { ... }
    fn from_js<T>(js: T) -> Result<Self, Error>
       where T: Into<JsValue>,
             Self: DeserializeOwned { ... }
}

Expand description

Tsify is a trait that allows you to convert a type to and from JavaScript. Can be implemented manually if you need to customize the serialization or deserialization.

Required Associated Constants§

const DECL: &'static str

Provided Associated Constants§

const SERIALIZATION_CONFIG: SerializationConfig = _

Required Associated Types§

type JsType: JsCast

Provided Methods§

fn into_js(&self) -> Result<Self::JsType, Error>
where Self: Serialize,

fn from_js<T>(js: T) -> Result<Self, Error>
where T: Into<JsValue>, Self: DeserializeOwned,

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementations on Foreign Types§

§

impl Tsify for I18nString

§

const DECL: &'static str = "export type I18nString = { Key: string } | { Translated: string };"

§

const SERIALIZATION_CONFIG: SerializationConfig

§

Source §

const SERIALIZATION_CONFIG: SerializationConfig

Source §

Trait TsifyCopy item path

Required Associated Constants§

const DECL: &'static str

Provided Associated Constants§

const SERIALIZATION_CONFIG: SerializationConfig = _

Required Associated Types§

type JsType: JsCast

Provided Methods§

fn into_js(&self) -> Result<Self::JsType, Error>where Self: Serialize,

fn from_js<T>(js: T) -> Result<Self, Error>where T: Into<JsValue>, Self: DeserializeOwned,

Dyn Compatibility§

Implementations on Foreign Types§

impl Tsify for I18nString

const DECL: &'static str = "export type I18nString = { Key: string } | { Translated: string };"

const SERIALIZATION_CONFIG: SerializationConfig

type JsType = JsType

Implementors§

impl Tsify for AbilityCaseRollType

const SERIALIZATION_CONFIG: SerializationConfig

type JsType = JsType

impl Tsify for AbilityCastType

const DECL: &'static str = "declare namespace AbilityCastType {\n export type NoAnimation = \"NoAnimation\";\n export type Basic = \"Basic\";\n export type Spell = \"Spell\";\n}\n\nexport type AbilityCastType = \"NoAnimation\" | \"Basic\" | \"Spell\";"

const SERIALIZATION_CONFIG: SerializationConfig

type JsType = JsType

impl Tsify for AbilityFightUiVisibility

const DECL: &'static str = "declare namespace AbilityFightUiVisibility {\n export type Slotted = \"Slotted\";\n export type Class = \"Class\";\n export type Hidden = \"Hidden\";\n}\n\nexport type AbilityFightUiVisibility = \"Slotted\" | \"Class\" | \"Hidden\";"

const SERIALIZATION_CONFIG: SerializationConfig

type JsType = JsType

impl Tsify for AdPlacement

const SERIALIZATION_CONFIG: SerializationConfig

type JsType = JsType

impl Tsify for ArenaLeaderboardResponse

const DECL: &'static str = "export type ArenaLeaderboardResponse = { Ok: { league: League; leaderboard: RankingItem[]; character_ranking: RankingItem } } | { Error: { code: string; message: string } };"

const SERIALIZATION_CONFIG: SerializationConfig

type JsType = JsType

impl Tsify for ArenaMatchesHistoryResponse

const DECL: &'static str = "export type ArenaMatchesHistoryResponse = { Ok: { matches: Match[] } } | { Error: { code: string; message: string } };"

const SERIALIZATION_CONFIG: SerializationConfig

type JsType = JsType

impl Tsify for ArenaPvpPlayersResponse

const DECL: &'static str = "export type ArenaPvpPlayersResponse = { Ok: { opponents: MatchmakingOpponent[] } } | { Error: { code: string; message: string } };"

const SERIALIZATION_CONFIG: SerializationConfig

type JsType = JsType

impl Tsify for BundleClaimMode

const DECL: &'static str = "declare namespace BundleClaimMode {\n export type Sequential = \"Sequential\";\n export type AllAtOnce = \"AllAtOnce\";\n}\n\nexport type BundleClaimMode = \"Sequential\" | \"AllAtOnce\";"

const SERIALIZATION_CONFIG: SerializationConfig

type JsType = JsType

impl Tsify for BundleElement

const DECL: &'static str = "export type BundleElement = { Currencies: CurrencyUnit[] } | { Abilities: BundleAbility[] } | { Items: Item[] };"

const SERIALIZATION_CONFIG: SerializationConfig

type JsType = JsType

impl Tsify for BundleStepGeneric

const DECL: &'static str = "export type BundleStepGeneric = { Sequential: BundleStep } | { AllAtOnce: { bundle_id: BundleId; elements: BundleElement[]; has_pop_up: boolean } };"

const SERIALIZATION_CONFIG: SerializationConfig

type JsType = JsType

impl Tsify for BundleStepType

const DECL: &'static str = "declare namespace BundleStepType {\n export type Currency = \"Currency\";\n export type Ability = \"Ability\";\n export type Item = \"Item\";\n}\n\nexport type BundleStepType = \"Currency\" | \"Ability\" | \"Item\";"

const SERIALIZATION_CONFIG: SerializationConfig

type JsType = JsType

impl Tsify for GetCharacterStateResponse

const DECL: &'static str = "export type GetCharacterStateResponse = { Ok: { character_state: CharacterState } } | { Error: { code: string; message: string } };"

const SERIALIZATION_CONFIG: SerializationConfig

type JsType = JsType

impl Tsify for FightClass

const DECL: &'static str = "export type FightClass = \"Mage\" | \"Warrior\" | \"Archer\";"

const SERIALIZATION_CONFIG: SerializationConfig

type JsType = JsType

impl Tsify for ChatType

const DECL: &'static str = "export type ChatType = \"Global\" | \"Private\" | \"GlobalSystem\" | \"PersonalSystem\";"

const SERIALIZATION_CONFIG: SerializationConfig

type JsType = JsType

impl Tsify for ClassTier

const DECL: &'static str = "declare namespace ClassTier {\n export type S = \"S\";\n export type A = \"A\";\n export type B = \"B\";\n export type C = \"C\";\n}\n\nexport type ClassTier = \"S\" | \"A\" | \"B\" | \"C\";"

const SERIALIZATION_CONFIG: SerializationConfig

type JsType = JsType

impl Tsify for CurrencyConsumer

const SERIALIZATION_CONFIG: SerializationConfig

type JsType = JsType

impl Tsify for CurrencySource

const SERIALIZATION_CONFIG: SerializationConfig

Trait Tsify

fn into_js(&self) -> Result<Self::JsType, Error>
where Self: Serialize,

fn from_js<T>(js: T) -> Result<Self, Error>
where T: Into<JsValue>, Self: DeserializeOwned,