Repository files navigation

Crate	Status
typeshare
typeshare-core
typeshare-annotation
typeshare-cli

One tool to rule the types,

One tool to FFI them,

One tool to parse your Rust,

And in the darkness, compile them 💍

Do you like manually managing types that need to be passed through an FFI layer, so that your code doesn't archaically break at runtime? Be honest, nobody does. Typeshare is here to take that burden away from you! Leveraging the power of theserde library, Typeshare is a tool that converts yourRust types into their equivalent forms in Swift, Go**, Python**, Kotlin, Scala and Typescript, keepingyour cross-language codebase in sync. With automatic implementation for serialization and deserialization on both sides of the FFI, Typeshare does all the heavy lifting for you. It can even handle generics and convert effortlessly between standard libraries in different languages!

**A few caveats. Seehere for more details.

To install the CLI (Command Line Interface):

cargo install typeshare-cli

💡Note that the console command will betypeshare, nottypeshare-cli.

In yourCargo.toml, under[dependencies]:

typeshare ="1.0.0"

We've put together a book that documents (almost) everything you can do.

📚Read the Typeshare book here!

To generate FFI definitions for a target language, run thetypeshare command and specify the directory containing your rust code, the language you would like to generate for, and the file to which your generated definitions will be written:

typeshare ./my_rust_project --lang=kotlin --output-file=my_kotlin_definitions.kttypeshare ./my_rust_project --lang=swift --output-file=my_swift_definitions.swifttypeshare ./my_rust_project --lang=scala --output-file=my_scala_definitions.scalatypeshare ./my_rust_project --lang=typescript --output-file=my_typescript_definitions.ts

Include the#[typeshare] attribute with any struct or enum you define to generate definitions for that type in the selected output language.

// Rust type definitions#[typeshare]structMyStruct{my_name:String,my_age:u32,}#[typeshare]#[serde(tag ="type", content ="content")]enumMyEnum{MyVariant(bool),MyOtherVariant,MyNumber(u32),}

// Generated Typescript definitionsexportinterfaceMyStruct{my_name:string;my_age:number;}exporttypeMyEnum=|{type:"MyVariant",content:boolean}|{type:"MyOtherVariant",content:undefined}|{type:"MyNumber",content:number};

Are you getting weird deserialization issues? Did our procedural macro throw a confusing error at you? Are you trying to contribute and our existing codebase is confusing? (probably true) Did you have another problem not enumerated in this reductive list? Please open an issue in this repository and the 1Password team would be happy to help! That's what we're here for!

• Kotlin
• Scala
• Swift
• Typescript
• Go**
• Python** (see list of limitationshere)

If there is a language that you want Typeshare to generate definitions for, you can either:

1. Open an issue in this repository requesting your language of choice.
2. Implement support for that language and open a PR with your implementation. We would be eternally grateful! 🙏

** Right now, Go and Python support is experimental. Enable thego orpython features, respectively, when installing typeshare-cli if you want to use these.

Made with ❤️ and ☕ by the1Password team.

Does your team need a secure way to manage passwords and other credentials for your open source project? Head on over to ourother repository to get a 1Password Teams account on us:

✨1Password for Open Source Projects