Implement the Server Protocol

benches/balanced_pb.rs

@@ -9,16 +9,16 @@ criterion_main!(benches);
 criterion_group!(benches, fake_splits, actual_splits);
 
 fn run_with_splits(timer: &mut Timer, splits: &[f64]) {
-    timer.start();
-    timer.initialize_game_time();
-    timer.pause_game_time();
+    timer.start().unwrap();
+    timer.initialize_game_time().unwrap();
+    timer.pause_game_time().unwrap();
 
     for &split in splits {
-        timer.set_game_time(TimeSpan::from_seconds(split));
-        timer.split();
+        timer.set_game_time(TimeSpan::from_seconds(split)).unwrap();
+        timer.split().unwrap();
     }
 
-    timer.reset(true);
+    timer.reset(true).unwrap();
 }
 
 fn fake_splits(c: &mut Criterion) {

benches/layout_state.rs

@@ -18,7 +18,7 @@ fn artificial() -> (Timer, Layout, ImageCache) {
     run.push_segment(Segment::new("Foo"));
 
     let mut timer = Timer::new(run).unwrap();
-    timer.start();
+    timer.start().unwrap();
 
     (timer, Layout::default_layout(), ImageCache::new())
 }
@@ -28,7 +28,7 @@ fn real() -> (Timer, Layout, ImageCache) {
     let run = livesplit::parse(&buf).unwrap();
 
     let mut timer = Timer::new(run).unwrap();
-    timer.start();
+    timer.start().unwrap();
 
     (timer, Layout::default_layout(), ImageCache::new())
 }

benches/scene_management.rs

@@ -146,19 +146,19 @@ cfg_if::cfg_if! {
 
         fn start_run(timer: &mut Timer) {
             timer.set_current_timing_method(TimingMethod::GameTime);
-            timer.start();
-            timer.initialize_game_time();
-            timer.pause_game_time();
-            timer.set_game_time(TimeSpan::zero());
+            timer.start().unwrap();
+            timer.initialize_game_time().unwrap();
+            timer.pause_game_time().unwrap();
+            timer.set_game_time(TimeSpan::zero()).unwrap();
         }
 
         fn make_progress_run_with_splits_opt(timer: &mut Timer, splits: &[Option<f64>]) {
             for &split in splits {
                 if let Some(split) = split {
-                    timer.set_game_time(TimeSpan::from_seconds(split));
-                    timer.split();
+                    timer.set_game_time(TimeSpan::from_seconds(split)).unwrap();
+                    timer.split().unwrap();
                 } else {
-                    timer.skip_split();
+                    timer.skip_split().unwrap();
                 }
             }
         }

benches/software_rendering.rs

@@ -74,19 +74,19 @@ cfg_if::cfg_if! {
 
         fn start_run(timer: &mut Timer) {
             timer.set_current_timing_method(TimingMethod::GameTime);
-            timer.start();
-            timer.initialize_game_time();
-            timer.pause_game_time();
-            timer.set_game_time(TimeSpan::zero());
+            timer.start().unwrap();
+            timer.initialize_game_time().unwrap();
+            timer.pause_game_time().unwrap();
+            timer.set_game_time(TimeSpan::zero()).unwrap();
         }
 
         fn make_progress_run_with_splits_opt(timer: &mut Timer, splits: &[Option<f64>]) {
             for &split in splits {
                 if let Some(split) = split {
-                    timer.set_game_time(TimeSpan::from_seconds(split));
-                    timer.split();
+                    timer.set_game_time(TimeSpan::from_seconds(split)).unwrap();
+                    timer.split().unwrap();
                 } else {
-                    timer.skip_split();
+                    timer.skip_split().unwrap();
                 }
             }
         }

benches/svg_rendering.rs

@@ -82,19 +82,19 @@ cfg_if::cfg_if! {
 
         fn start_run(timer: &mut Timer) {
             timer.set_current_timing_method(TimingMethod::GameTime);
-            timer.start();
-            timer.initialize_game_time();
-            timer.pause_game_time();
-            timer.set_game_time(TimeSpan::zero());
+            timer.start().unwrap();
+            timer.initialize_game_time().unwrap();
+            timer.pause_game_time().unwrap();
+            timer.set_game_time(TimeSpan::zero()).unwrap();
         }
 
         fn make_progress_run_with_splits_opt(timer: &mut Timer, splits: &[Option<f64>]) {
             for &split in splits {
                 if let Some(split) = split {
-                    timer.set_game_time(TimeSpan::from_seconds(split));
-                    timer.split();
+                    timer.set_game_time(TimeSpan::from_seconds(split)).unwrap();
+                    timer.split().unwrap();
                 } else {
-                    timer.skip_split();
+                    timer.skip_split().unwrap();
                 }
             }
         }

capi/Cargo.toml

@@ -2,7 +2,7 @@
 name = "livesplit-core-capi"
 version = "0.11.0"
 authors = ["Christopher Serr <christopher.serr@gmail.com>"]
-edition = "2018"
+edition = "2021"
 
 [lib]
 name = "livesplit_core"
@@ -15,13 +15,14 @@ time = { version = "0.3.4", default-features = false, features = ["formatting"]
 simdutf8 = { git = "https://github.com/CryZe/simdutf8", branch = "wasm-ub-panic", default-features = false }
 
 wasm-bindgen = { version = "0.2.78", optional = true }
+wasm-bindgen-futures = { version = "0.4.28", optional = true }
 web-sys = { version = "0.3.28", optional = true }
 
 [features]
 default = ["image-shrinking"]
 image-shrinking = ["livesplit-core/image-shrinking"]
 software-rendering = ["livesplit-core/software-rendering"]
-wasm-web = ["livesplit-core/wasm-web", "wasm-bindgen", "web-sys"]
+wasm-web = ["livesplit-core/wasm-web", "wasm-bindgen", "wasm-bindgen-futures", "web-sys"]
 auto-splitting = ["livesplit-core/auto-splitting"]
 assume-str-parameters-are-utf8 = []
 web-rendering = ["wasm-web", "livesplit-core/web-rendering"]

capi/bind_gen/src/typescript.ts

@@ -216,6 +216,99 @@ export enum TimerPhase {
     Paused = 3,
 }
 
+/** An event informs you about a change in the timer. */
+export enum Event {
+    /** The timer has been started. */
+    Started = 0,
+    /**
+     * A split happened. Note that the final split is signaled by `Finished`.
+     */
+    Splitted = 1,
+    /**
+     * The final split happened, the run is now finished, but has not been reset
+     * yet.
+     */
+    Finished = 2,
+    /** The timer has been reset. */
+    Reset = 3,
+    /** The previous split has been undone. */
+    SplitUndone = 4,
+    /** The current split has been skipped. */
+    SplitSkipped = 5,
+    /** The timer has been paused. */
+    Paused = 6,
+    /** The timer has been resumed. */
+    Resumed = 7,
+    /** All the pauses have been undone. */
+    PausesUndone = 8,
+    /** All the pauses have been undone and the timer has been resumed. */
+    PausesUndoneAndResumed = 9,
+    /** The comparison has been changed. */
+    ComparisonChanged = 10,
+    /** The timing method has been changed. */
+    TimingMethodChanged = 11,
+    /** The game time has been initialized. */
+    GameTimeInitialized = 12,
+    /** The game time has been set. */
+    GameTimeSet = 13,
+    /** The game time has been paused. */
+    GameTimePaused = 14,
+    /** The game time has been resumed. */
+    GameTimeResumed = 15,
+    /** The loading times have been set. */
+    LoadingTimesSet = 16,
+    /** A custom variable has been set. */
+    CustomVariableSet = 17,
+}
+
+/** An error that occurred when a command was being processed. */
+export enum CommandError {
+    /** The operation is not supported. */
+    Unsupported = -1,
+    /** The timer can't be interacted with at the moment. */
+    Busy = -2,
+    /** There is already a run in progress. */
+    RunAlreadyInProgress = -3,
+    /** There is no run in progress. */
+    NoRunInProgress = -4,
+    /** The run is already finished. */
+    RunFinished = -5,
+    /** The time is negative, you can't split yet. */
+    NegativeTime = -6,
+    /** The last split can't be skipped. */
+    CantSkipLastSplit = -7,
+    /** There is no split to undo. */
+    CantUndoFirstSplit = -8,
+    /** The timer is already paused. */
+    AlreadyPaused = -9,
+    /** The timer is not paused. */
+    NotPaused = -10,
+    /** The requested comparison doesn't exist. */
+    ComparisonDoesntExist = -11,
+    /** The game time is already initialized. */
+    GameTimeAlreadyInitialized = -12,
+    /** The game time is already paused. */
+    GameTimeAlreadyPaused = -13,
+    /** The game time is not paused. */
+    GameTimeNotPaused = -14,
+    /** The time could not be parsed. */
+    CouldNotParseTime = -15,
+    /** The timer is currently paused. */
+    TimerPaused = -16,
+    /** The runner decided to not reset the run. */
+    RunnerDecidedAgainstReset = -17,
+}
+
+/** The result of a command that was processed. */
+export type CommandResult = Event | CommandError;
+
+/**
+ * Checks if the result of a command is a successful event instead of an error.
+ */
+export function isEvent(result: CommandResult): result is Event {
+    return result >= 0;
+}
+
 /** The state object describes the information to visualize for this component. */
 export interface BlankSpaceComponentStateJson {
     /** The background shown behind the component. */