brink_runtime/
lib.rs

1//! Runtime/VM for executing compiled ink stories.
2//!
3//! The runtime takes a [`StoryData`](brink_format::StoryData) from the compiler,
4//! links it into an immutable [`Program`], and executes it via [`Story`].
5//!
6//! ```ignore
7//! let (program, line_tables) = brink_runtime::link(&story_data)?;
8//! let mut story = brink_runtime::Story::new(&program, line_tables);
9//! loop {
10//!     match story.continue_single()? {
11//!         Line::Text { text, .. } => print!("{text}"),
12//!         Line::Choices { text, choices, .. } => {
13//!             print!("{text}");
14//!             // pick a choice...
15//!             story.choose(0)?;
16//!         }
17//!         Line::End { text, .. } => {
18//!             print!("{text}");
19//!             break;
20//!         }
21//!     }
22//! }
23//! ```
24
25mod debug;
26mod error;
27mod linker;
28mod list_ops;
29mod locale;
30mod output;
31mod program;
32mod replay;
33pub mod rng;
34mod save;
35mod session;
36mod state;
37mod story;
38pub mod transcript;
39mod value_ops;
40mod vm;
41
42pub use brink_format::{LoadReport, SAVE_FORMAT_VERSION, SaveState, VisitEntry};
43pub use debug::{DebugChoice, DebugFrame, DebugGlobal, DebugRng, DebugSnapshot, DebugVisit};
44pub use error::RuntimeError;
45pub use linker::link;
46pub use locale::{LocaleMode, apply_locale};
47pub use output::{Fragment, OutputPart};
48pub use program::Program;
49pub use replay::{
50    RECORDING_CAP, RecordedExternal, RecordingHandler, ReplayHandler, ReplayMode, ReplayRecorder,
51};
52pub use rng::{DotNetRng, FastRng, StoryRng};
53pub use session::{
54    DivergenceFound, EventKind, ExternalReplayMode, FailReason, JournalEvent, ListDelta,
55    ReplayOutcome, ReplayWarning, SESSION_JOURNAL_CAP, SESSION_JOURNAL_VERSION, SessionError,
56    SessionJournal, SnapshotFrame, SnapshotList, SnapshotStatus, StateDiff, StateSnapshot,
57    StorySession, diff,
58};
59pub use state::{ContextAccess, ObservedContext, WriteObserver};
60pub use story::{
61    Choice, Context, ExternalFnHandler, ExternalResult, FallbackHandler, FlowInstance,
62    FunctionEval, Line, Stats, StepOutcome, Story, StorySnapshot, StoryStatus,
63};
brink_runtime/lib.rs

brink_runtime/
lib.rs
