From 543672796161e1ab500ed446611d391a451add09 Mon Sep 17 00:00:00 2001 From: Valentin Popov Date: Mon, 22 Jun 2026 16:04:35 +0400 Subject: docs: mark stage 4 runtime gaps explicit --- crates/fparkan-fx/src/lib.rs | 19 ++++++++++++------- 1 file changed, 12 insertions(+), 7 deletions(-) (limited to 'crates/fparkan-fx/src') diff --git a/crates/fparkan-fx/src/lib.rs b/crates/fparkan-fx/src/lib.rs index fb8adff..b1b5071 100644 --- a/crates/fparkan-fx/src/lib.rs +++ b/crates/fparkan-fx/src/lib.rs @@ -1,5 +1,10 @@ #![forbid(unsafe_code)] //! FXID effect contracts. +//! +//! FXID decoding and command framing are implemented as compatibility +//! contracts. The create/update/emit lifecycle below is a deterministic +//! reference stub until opcode timing, gates, RNG, and command-body semantics +//! are backed by runtime-captured evidence. use fparkan_binary::{Cursor, DecodeError}; use std::sync::Arc; @@ -121,7 +126,7 @@ impl Default for Transform { #[derive(Clone, Copy, Debug, Default, Eq, PartialEq)] pub struct GameTime(pub u64); -/// FX runtime state. +/// FX reference-stub runtime state. #[derive(Clone, Debug)] pub struct FxState { /// Instance id. @@ -322,12 +327,12 @@ pub fn decode_fxid(bytes: Arc<[u8]>) -> Result { }) } -/// Creates an FX instance. +/// Creates a deterministic FX reference-stub instance. /// /// # Errors /// /// Currently returns [`FxError`] only for future resource/lifecycle validation -/// hooks; creation is deterministic for a decoded document. +/// hooks. This function does not claim original runtime parity. pub fn create_instance( document: Arc, seed: FxSeed, @@ -344,21 +349,21 @@ pub fn create_instance( }) } -/// Updates FX simulation time without emitting side effects. +/// Updates reference-stub FX simulation time without emitting side effects. /// /// # Errors /// -/// Reserved for future runtime validation. +/// Reserved for future runtime-captured compatibility validation. pub fn update(state: &mut FxState, time: GameTime) -> Result<(), FxError> { state.time = time; Ok(()) } -/// Emits active commands without advancing state. +/// Emits reference-stub active commands without advancing state. /// /// # Errors /// -/// Reserved for future resource/runtime validation. +/// Reserved for future resource/runtime-captured compatibility validation. pub fn emit(state: &FxState, out: &mut Vec) -> Result<(), FxError> { if state.lifecycle != FxLifecycle::Running { return Ok(()); -- cgit v1.2.3