Embed Styx schemas in binaries for zero-execution discovery.

This crate provides macros to embed schemas in your binary, and functions to extract them without executing the binary. This enables tooling (LSP, CLI) to discover schemas safely.

Embedding schemas

Each schema must have a meta { id ... } block. The ID is used to generate a unique static name, allowing multiple schemas to coexist in the same binary.

Inline strings

styx_embed::embed_inline!(r#"
meta { id my-config, version 1.0.0 }
schema { @ @object{ host @string, port @int } }
"#);

From files

// Single file (path relative to crate root)
styx_embed::embed_file!("schema.styx");

// Multiple files (each becomes its own embedded schema)
styx_embed::embed_files!("config.styx", "plugin.styx");

Generated from types (build script pattern)

For schemas derived from Rust types using facet-styx, use a build script:

// build.rs
fn main() {
    facet_styx::GenerateSchema::<MyConfig>::new()
        .crate_name("myapp-config")
        .version("1")
        .cli("myapp")
        .write("schema.styx");
}

// src/main.rs
styx_embed::embed_outdir_file!("schema.styx");

This keeps the schema in sync with your types automatically.

Binary format (V2)

Each embedded schema is stored as its own blob:

STYX_SCHEMA_V2\0\0           // 16 bytes magic
<decompressed_len:u32le>
<compressed_len:u32le>
<blake3:32bytes>             // hash of decompressed content
<lz4 compressed schema>

Multiple schemas in a binary means multiple blobs, each with its own magic header. The schema's meta { id ... } is used to identify which schema is which.

Extracting schemas

use styx_embed::extract_schemas;

let schemas = extract_schemas(binary_bytes)?;
for schema in schemas {
    println!("{}", schema);
}