sim-lib-surface-card 0.1.0-rc.1

Shared, plain-data surface-card spine.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30

//! Shared, plain-data surface-card spine.
//!
//! This crate holds the codec-neutral pieces of a "surface card": the
//! external-name policy used when projecting a kernel [`Symbol`](sim_kernel::Symbol)
//! onto a foreign tool surface (MCP, OpenAI, file system, human-facing text) and
//! a plain-data [`SurfaceDescriptor`] spine that depends only on kernel types.
//!
//! Concrete surfaces (for example `sim-lib-skill`'s OpenAI tool descriptor)
//! derive their external names through [`external_name`], keeping a single
//! source of truth for the mangling rules.
//!
//! # Example
//!
//! ```
//! use sim_kernel::Symbol;
//! use sim_lib_surface_card::{ExternalNamePolicy, external_name};
//!
//! let symbol = Symbol::qualified("skill", "do.thing");
//! assert_eq!(external_name(&symbol, ExternalNamePolicy::OpenAiTool), "skill_do_thing");
//! assert_eq!(external_name(&symbol, ExternalNamePolicy::HumanReadable), "skill/do.thing");
//! ```

#![forbid(unsafe_code)]
#![deny(missing_docs)]

mod descriptor;
mod name;

pub use descriptor::SurfaceDescriptor;
pub use name::{ExternalNamePolicy, external_name};