4 releases

0.1.4 May 21, 2022
0.1.3 Nov 17, 2021
0.0.2 Sep 14, 2021
0.0.1 Feb 17, 2021

#15 in WebSocket

Download history 12/week @ 2022-03-13 9/week @ 2022-03-20 3/week @ 2022-04-03 1/week @ 2022-04-17 3/week @ 2022-04-24 11/week @ 2022-05-01 23/week @ 2022-05-08 61/week @ 2022-05-15 36/week @ 2022-05-22 44/week @ 2022-05-29 32/week @ 2022-06-05 3/week @ 2022-06-12 11/week @ 2022-06-19

95 downloads per month

MIT license

28KB
526 lines

Aper

GitHub Repo stars crates.io docs.rs wokflow state

Cartoonized face of an ape.

Aper is a data structure library in which every data structure is a state machine, and every mutation is a first-class value that can be serialized and sent over the network, or stored for later.

What is a state machine?

For the purposes of Aper, a state machine is simply a struct or enum that implements StateMachine and has the following properties:

  • It defines a StateMachine::Transition type, through which every possible change to the state can be described. It is usually useful, though not required, that this be an enum type.
  • It defines a StateMachine::Conflict type, which describes a conflict which may occur when a transition is applied that is not valid at the time it is applied. For simple types where a conflict is impossible, you can use NeverConflict for this.
  • All state updates are deterministic: if you clone a StateMachine and a Transition, the result of applying the cloned transition to the cloned state must be identical to applying the original transition to the original state.

Here's an example StateMachine implementing a counter:

use aper::{StateMachine, NeverConflict};
use serde::{Serialize, Deserialize};

#[derive(Serialize, Deserialize, Clone, Debug, Default)]
struct Counter { value: i64 };

#[derive(Serialize, Deserialize, Clone, Debug, PartialEq)]
enum CounterTransition {
    Reset,
    Increment(i64),
    Decrement(i64),
}

impl StateMachine for Counter {
    type Transition = CounterTransition;
    type Conflict = NeverConflict;

    fn apply(&mut self, event: CounterTransition) -> Result<(), NeverConflict> {
        match event {
            CounterTransition::Reset => { self.value = 0 }
            CounterTransition::Increment(amount) => { self.value += amount }
            CounterTransition::Decrement(amount) => { self.value -= amount }
        }

        Ok(())
    }
}

Why not CRDT?

Conflict-free replicated data types are a really neat way of representing data that's shared between peers. In order to avoid the need for a central “source of truth”, CRDTs require that update operations (i.e. state transitions) be commutative. This allows them to represent a bunch of common data structures, but doesn't allow you to represent arbitrarily complex update logic. By relying on a central authority, a state-machine approach allows you to implement data structures with arbitrary update logic, such as atomic moves of a value between two data structures, or the rules of a board game.


Aper is rapidly evolving. Consider this a technology preview. See the list of issues outstanding for version 1.0

Dependencies

~0.6–1.1MB
~25K SLoC