Jengamon/magister_engine - Change ELOGL26SONVBON2Q7MTZY2AW3ERCUMCHM3YLV7AJDG7ZYL6ET7SAC

fix: start sketching out engine API

Created by Jengamon on April 10, 2024

ELOGL26SONVBON2Q7MTZY2AW3ERCUMCHM3YLV7AJDG7ZYL6ET7SAC

Dependencies

In channels

main

Change contents

Replacement in src/lib.rs at line 4 [3.48]

B:BD[3.118] → [3.118:161]

#[cfg(test)]
mod tests {
    use super::*;

[3.118]

[3.263]

/// These are uniquely assigned to players and *never* change.
// (Thus they should *not* be present in BoardState)
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub struct PlayerId(ulid::Ulid);
/// The kinds of actions that exist
pub enum ActionPayload {}
/// Represents an action that a player may take
struct Action {
    payload: ActionPayload,
    player: PlayerId,

Insertion in src/lib.rs at line 17 [3.48]
[3.265]
```
#[cfg(test)]
mod tests {}
```

Insertion in README.md at line 8 [3.1423]

[2.187]

- the main directory contains the engine with consists of:
  - a non-reactive publically mutable version of game state: the `BoardState`
  - an opaque reactive version of game state: the `RunningGame`
## Design Ideas
I will try Domain-Oriented Design, so I'm splitting things into the `BoardState` and `RunningGame`.
A `BoardState` is meant to be externally manipulable, so it relies on having public owned data.
Avoid strategies for deduplication, it should be *really* straight-forward to make w/e changes you want
that *could* be proper game actions from the `BoardState`.
A `RunningGame` should be optimized for *running* a game, and reducers and inferers work with this struct.
I'm keeping the idea for having reducers and inferers, but due to the difference in using DOD, we can change some signatures:
- a reducer is an `fn(&mut RunnningGame, act: Action) -> &mut RunningGame`, it can now mutate a RunningGame,
as RunningGame is no longer responsible for being serializable or externally manipulable in general.
- an inferer is `fn(&RunningGame) -> Vec<Action>` and should list all the possible actions that can be taken.
- and we need something that can produce `BoardState`s `fn(&RunningGame) -> BoardState`, possibly memoized
in case *creating* the `BoardState` is expensive.

Insertion in Cargo.toml at line 17 [3.1547]
[2.283]
[4.8778]
```
flume = "0.11.0"
```
Insertion in Cargo.toml at line 19 [3.1547]
[4.8793]
[3.1826]
```
oneshot = "0.1.6"
```
Insertion in Cargo.toml at line 24 [3.1547]
[3.1973]
[3.1973]
```
ulid = { version = "1.1.2", features = ["serde"] }
```

Insertion in Cargo.lock at line 530 [3.2104]

[2.7364]

name = "flume"
version = "0.11.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "55ac459de2512911e4b674ce33cf20befaba382d05b62b008afc1c8b57cbf181"
dependencies = [
 "futures-core",
 "futures-sink",
 "nanorand",
 "spin",
]
[[package]]

Insertion in Cargo.lock at line 643 [3.2104]

[2.9845]

]
[[package]]
name = "generator"
version = "0.7.5"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "5cc16584ff22b460a382b7feec54b23d2908d858152e5739a120b949293bd74e"
dependencies = [
 "cc",
 "libc",
 "log",
 "rustversion",
 "windows",

Insertion in Cargo.lock at line 1124 [3.2104]

[4.17699]


[[package]]
name = "loom"
version = "0.5.6"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "ff50ecb28bb86013e935fb6683ab1f6d3a20016f123c76fd4c27470076ac30f5"
dependencies = [
 "cfg-if",
 "generator",
 "pin-utils",
 "scoped-tls",
 "tracing",
 "tracing-subscriber",
]

Insertion in Cargo.lock at line 1155 [3.2104]
[2.17107]
[4.17934]
```
 "flume",
```
Insertion in Cargo.lock at line 1158 [3.2104]
[4.17959]
[3.3431]
```
 "oneshot",
```
Insertion in Cargo.lock at line 1163 [3.2104]
[3.3475]
[3.3475]
```
 "ulid",
```

Insertion in Cargo.lock at line 1190 [3.2104]

[2.17644]

[3.3490]

name = "matchers"
version = "0.1.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "8263075bb86c5a1b1427b5ae862e8889656f126e9f77c484496e8b47cf5c5558"
dependencies = [
 "regex-automata 0.1.10",
]
[[package]]

Insertion in Cargo.lock at line 1229 [3.2104]

[4.18438]

]
[[package]]
name = "nanorand"
version = "0.7.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "6a51313c5820b0b02bd422f4b44776fbf47961755c74ce64afc73bfad10226c3"
dependencies = [
 "getrandom",

Insertion in Cargo.lock at line 1248 [3.2104]

[2.18067]

]
[[package]]
name = "nu-ansi-term"
version = "0.46.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "77a8165726e8236064dbb45459242600304b42a5ea24ee2948e18e023bf7ba84"
dependencies = [
 "overload",
 "winapi",

Insertion in Cargo.lock at line 1290 [3.2104]

[4.19091]


[[package]]
name = "oneshot"
version = "0.1.6"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "6f6640c6bda7731b1fdbab747981a0f896dd1fedaf9f4a53fa237a04a84431f4"
dependencies = [
 "loom",
]

Insertion in Cargo.lock at line 1301 [3.2104]

[4.19104]

[2.18275]

name = "overload"
version = "0.1.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "b15813163c1d831bf4a13c3610c05c0d03b39feb07f7e09fa234dac9b15aaf39"
[[package]]

Replacement in Cargo.lock at line 1616 [3.2104]

B:BD[3.4360] → [3.4360:4396]

 "regex-automata",
 "regex-syntax",

[3.4360]

[3.4396]

 "regex-automata 0.4.6",
 "regex-syntax 0.8.3",
]
[[package]]
name = "regex-automata"
version = "0.1.10"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "6c230d73fb8d8c1b9c0b3135c5142a8acee3a0558fb8db5cf1cb65f8d7862132"
dependencies = [
 "regex-syntax 0.6.29",

Replacement in Cargo.lock at line 1637 [3.2104]
B:BD[3.4641] → [3.4641:4658]
```
 "regex-syntax",
```
[3.4641]
[3.4658]
```
 "regex-syntax 0.8.3",
```

Insertion in Cargo.lock at line 1642 [3.2104]

[3.4695]

version = "0.6.29"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "f162c6dd7b008981e4d40210aca20b4bd0f9b60ca9271061b07f78537722f2e1"
[[package]]
name = "regex-syntax"

Insertion in Cargo.lock at line 1711 [3.2104]

[2.22636]

[4.23206]

name = "scoped-tls"
version = "1.0.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "e1cf6437eb19a8f4a6cc0f7dca544973b0b78843adbfeb3683d1a94a0024a294"
[[package]]

Insertion in Cargo.lock at line 1870 [3.2104]

[4.23662]

]
[[package]]
name = "sharded-slab"
version = "0.1.7"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "f40ca3c46823713e0d4209592e8d6e826aa57e928f09752619fc696c499637f6"
dependencies = [
 "lazy_static",

Insertion in Cargo.lock at line 1950 [3.2104]

[4.25020]

]
[[package]]
name = "spin"
version = "0.9.8"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "6980e8d7511241f8acf4aebddbb1ff938df5eebe98691418c4468d0b72a96a67"
dependencies = [
 "lock_api",

Insertion in Cargo.lock at line 2085 [3.2104]

[2.26482]

name = "thread_local"
version = "1.1.8"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "8b9ef9bad013ada3808854ceac7b46812a6465ba368859a37e2100283d2d719c"
dependencies = [
 "cfg-if",
 "once_cell",
]
[[package]]

Insertion in Cargo.lock at line 2240 [3.2104]

[2.29138]

dependencies = [
 "once_cell",
 "valuable",
]
[[package]]
name = "tracing-log"
version = "0.2.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "ee855f1f400bd0e5c02d150ae5de3840039a3f54b025156404e34c23c03f47c3"

Insertion in Cargo.lock at line 2251 [3.2104]
[2.29155]
[2.29155]
```
 "log",
```
Insertion in Cargo.lock at line 2253 [3.2104]
[2.29169]
[2.29169]
```
 "tracing-core",
```

Insertion in Cargo.lock at line 2257 [3.2104]

[2.29184]

name = "tracing-subscriber"
version = "0.3.18"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "ad0f048c97dbd9faa9b7df56362b8ebcaa52adb06b498c050d2f4e32f90a7a8b"
dependencies = [
 "matchers",
 "nu-ansi-term",
 "once_cell",
 "regex",
 "sharded-slab",
 "smallvec",
 "thread_local",
 "tracing",
 "tracing-core",
 "tracing-log",
]
[[package]]

Insertion in Cargo.lock at line 2307 [3.2104]

[2.29688]

name = "ulid"
version = "1.1.2"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "34778c17965aa2a08913b57e1f34db9b4a63f5de31768b55bf20d2795f921259"
dependencies = [
 "getrandom",
 "rand",
 "serde",
 "web-time",
]
[[package]]

Insertion in Cargo.lock at line 2384 [3.2104]

[4.27574]

name = "valuable"
version = "0.1.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "830b7e5d4d90034032940e4ace0d9a9a057e7a45cd94e6c007832e39edb82f6d"
[[package]]

Insertion in Cargo.lock at line 2501 [3.2104]

[4.27983]

name = "web-time"
version = "1.1.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "5a6580f308b1fad9207618087a65c04e7a10bc77e02c8e84e9b00dd4b12fa0bb"
dependencies = [
 "js-sys",
 "wasm-bindgen",
]
[[package]]

Insertion in Cargo.lock at line 2540 [3.2104]

[4.28665]


[[package]]
name = "windows"
version = "0.48.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "e686886bc078bc1b0b600cac0147aadb815089b6e4da64016cbd754b6342700f"
dependencies = [
 "windows-targets 0.48.5",
]