Skip to content

User Guides

This section teaches the normal XIDL workflow:

  1. Install xidlc
  2. Write IDL
  3. Generate artifacts for a target
  4. Integrate the generated output into your project
  1. Installation
  2. Quickstart
  3. Using xidlc
  4. IDL Guide
  5. Using xidl-build in Rust
  6. HTTP Guide or JSON-RPC Guide

What you can do after reading

  • Install and run xidlc
  • Generate Rust, C, C++, TypeScript, OpenAPI, or OpenRPC output
  • Use xidl-build in build.rs
  • Write IDL with the syntax currently supported by this repository
  • Understand the practical transport model before reading the RFCs