ftui-runtime 0.3.1

Elm-style runtime loop and subscriptions for FrankenTUI.
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
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126

[package]
name = "ftui-runtime"
version = "0.3.1"
edition = "2024"
license-file = "../../LICENSE"
description = "Elm-style runtime loop and subscriptions for FrankenTUI."
repository = "https://github.com/Dicklesworthstone/frankentui"
homepage = "https://github.com/Dicklesworthstone/frankentui"
documentation = "https://docs.rs/ftui-runtime"
readme = "../../README.md"
keywords = ["tui", "terminal", "ui", "ftui", "frankentui"]
categories = ["command-line-interface", "gui"]

[features]
default = []
# Enable dedicated render/output thread (Mode B).
# When enabled, all terminal output is serialized on a background thread,
# preventing interleaving between logs and UI presents.
render-thread = []
# Best-effort stdio capture to prevent accidental println! from corrupting
# inline mode. See stdio_capture module docs for limitations.
stdio-capture = []
# Enable tracing instrumentation for runtime internals.
tracing = []
# Enable widget state persistence with JSON file storage.
# Adds FileStorage backend for cross-session state persistence.
state-persistence = ["dep:serde", "dep:serde_json", "dep:base64"]
# Enable policy-as-data configuration loading from TOML/JSON files.
policy-config = ["dep:serde", "dep:serde_json", "dep:toml"]
# Legacy Crossterm backend compatibility. Enables CrosstermEventSource and the
# `Program::new()`/`Program::with_config()` constructors that use TerminalSession.
crossterm-compat = ["ftui-core/crossterm"]
# Native TTY backend (replaces Crossterm on Unix). When enabled, provides
# `Program::with_native_backend()` constructor using `ftui-tty`.
native-backend = ["dep:ftui-tty"]
# Enable persistent data structures (HAMT) for O(1) snapshot-based undo/redo.
# Re-exports `im` crate types (HashMap, Vector, OrdMap) through `ftui_runtime::undo::persistent`.
hamt = ["dep:im"]
# Enable event trace recording and replay for deterministic debugging.
# Adds JSONL + gzip serialization of input events with nanosecond timestamps.
event-trace = ["dep:serde", "dep:serde_json", "dep:flate2"]
# Enable OpenTelemetry telemetry export via OTLP.
# When enabled, spans can be exported to an OTLP collector.
# Zero overhead when feature is off; minimal overhead when on but disabled via env.
telemetry = [
    "dep:opentelemetry",
    "dep:opentelemetry_sdk",
    "dep:opentelemetry-otlp",
    "dep:tracing-opentelemetry",
    "dep:tracing-subscriber",
]
# Enable Asupersync-backed blocking task execution behind the existing runtime APIs.
asupersync-executor = ["dep:asupersync"]

[dependencies]
ftui-backend = { path = "../ftui-backend", version = "0.3.1" }
ftui-core = { path = "../ftui-core", version = "0.3.1" }
ftui-layout = { path = "../ftui-layout", version = "0.3.1" }
ftui-i18n = { path = "../ftui-i18n", version = "0.3.1" }
ftui-render = { path = "../ftui-render", version = "0.3.1" }
ftui-style = { path = "../ftui-style", version = "0.3.1" }
ftui-text = { path = "../ftui-text", version = "0.3.1" }
ftui-tty = { path = "../ftui-tty", version = "0.3.1", optional = true }
arc-swap = "1.8.2"
tracing = "0.1.41"
unicode-segmentation = "1.12.0"
unicode-width = "0.2.2"
web-time = "1.1.0"
asupersync = { version = "0.2.9", optional = true }

# Optional telemetry dependencies (feature-gated)
opentelemetry = { version = "0.31", optional = true }
opentelemetry_sdk = { version = "0.31", optional = true }
opentelemetry-otlp = { version = "0.31", default-features = false, features = ["http-proto", "reqwest-blocking-client"], optional = true }
tracing-opentelemetry = { version = "0.32", optional = true }
tracing-subscriber = { version = "0.3.20", features = ["registry", "env-filter"], optional = true }

# State persistence dependencies (feature-gated)
serde = { version = "1.0.227", features = ["derive"], optional = true }
serde_json = { version = "1.0.145", optional = true }
base64 = { version = "0.22", optional = true }
im = { version = "15.1", optional = true }
flate2 = { version = "1.1", optional = true }
toml = { version = "0.8", optional = true }

[dev-dependencies]
ftui-core = { path = "../ftui-core", version = "0.3.1", features = ["test-helpers"] }
ftui-harness = { path = "../ftui-harness" }
criterion = { version = "0.8.2", features = ["html_reports"] }
proptest = "1.7.0"
tempfile = "3.22.0"
serde = { version = "1.0.227", features = ["derive"] }
serde_json = "1.0.145"
base64 = "0.22"
im = "15.1"
flate2 = "1.1"
# OpenTelemetry testing infrastructure
opentelemetry = "0.31"
opentelemetry_sdk = { version = "0.31", features = ["testing"] }
tracing-opentelemetry = "0.32"
tracing-subscriber = { version = "0.3.20", features = ["registry", "env-filter"] }

[[test]]
name = "deterministic_replay"
required-features = ["event-trace"]

[[test]]
name = "e2e_recipe_d_deterministic_replay"
required-features = ["event-trace"]

[[bench]]
name = "telemetry_bench"
harness = false
required-features = ["telemetry"]

[[bench]]
name = "tick_strategy_bench"
harness = false

[[bench]]
name = "ivm_bench"
harness = false

[[bench]]
name = "pane_terminal_bench"
harness = false