openstranded-common-wasmcontract 0.1.0

OpenStranded WASM contract types — shared between engine and plugin-api
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
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54

//! # openstranded-common-wasmcontract
//!
//! Shared WASM contract types for OpenStranded — the core types and traits
//! that both the engine and the plugin SDK use to communicate across the
//! WASM boundary.
//!
//! This crate is the single source of truth for all contract types:
//!
//! - [`Value`]: dynamic type for cross-plugin arguments and return values
//! - [`ServiceError`]: typed errors for Service API calls
//! - [`Service`]: cross-plugin method call interface (trait)
//! - [`Registry`]: in-memory content pack data store
//! - [`RegistryEntry`]: a single file from content pack (data + filename)
//! - [`GameAPI`]: host-side API surface provided to plugins
//! - [`Contribution`]: declarative output from WASM plugin `build()` phase
//! - [`ApiVersion`]: compile-time baked version for compatibility checks
//! - [`LogLevel`]: log severity level
//!
//! ## Feature flags
//!
//! - `parse` (default): enables [`parse_registry_data`] and [`parse_registry_list`]
//! - `std` (default): enables types that require the standard library
//!
//! ## Crate relationships
//!
//! ```text
//! openstranded (engine)  ──┐
//!                          ├── openstranded-common-wasmcontract
//! openstranded-plugin-api ──┘
//! ```
//!
//! The engine and `plugin-api` both depend on this crate for shared types.
//! The `plugin-api` crate re-exports everything and adds test utilities
//! (`MockGameAPI`) and WASM entry point stubs.

mod value;
mod error;
mod service;
mod registry;
mod game_api;
mod contributions;
mod version;

// ── Re-exports ─────────────────────────────────────────────────────

pub use value::Value;
pub use error::ServiceError;
pub use service::Service;
pub use registry::{Registry, RegistryEntry};
#[cfg(feature = "parse")]
pub use registry::{parse_registry_data, parse_registry_list};
pub use game_api::{GameAPI, LogLevel};
pub use contributions::{Contribution, SystemDecl, ResourceDecl};
pub use version::{ApiVersion, VersionMismatch};