oxframe_protocol/lib.rs
1//! Protocol shared by the engine (`oxframe-preview`), the CLI and `editor-ui`.
2//!
3//! > **Status:** oxframe is under very active development. The API is not stable yet and
4//! > may change from version to version. Pin the exact version in your Cargo.toml and check
5//! > the [changelog](https://github.com/oxygenframe/oxframe-sdk/blob/main/CHANGELOG.md)
6//! > before upgrading.
7//!
8//! This crate is the single source of truth: TypeScript types for
9//! `@oxframe/protocol` are generated from it with `ts-rs`.
10
11#![warn(missing_docs)]
12
13mod messages;
14mod meta;
15
16pub use messages::*;
17pub use meta::*;
18
19/// Incremented on every incompatible change of [`Command`], [`Event`] or the
20/// binary frame header. Every side compares it in `Hello`/`Ready`.
21pub const PROTOCOL_VERSION: u32 = 1;