spru 0.1.0

Reusable components for the spru strategy and digital board game framework.
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

pub mod error;
mod seed;
pub use seed::Seed;
pub mod signal;
mod snapshot;
pub(crate) use snapshot::Snapshot;

use std::marker::PhantomData;

use derive_where::derive_where;

/// Associated types shared between [Server](crate::Server) and [Client](crate::Client).  
/// [Client::Common](crate::Client::Common) == [Server::Common](crate::Server::Common) for clients and servers in the same game.  
#[allow(missing_docs)]
pub trait Common: crate::sealed::Sealed + Sized {
    /// The set of all [Item](crate::Item) types in the game.  
    /// See [State](trait@crate::State).
    type State;
    /// The set of all actions that can be applied to [State](Common::State)s.  
    /// See [Action](trait@crate::Action).
    type Action;
    /// The type of a value accessible to all [Interactor](crate::Interactor)s.  
    /// All game items should be accessible from this value.
    type Root;
    /// Player-initiated interaction with the game state.  
    /// See [Interaction](trait@crate::Interaction).
    type Interaction;
    /// The final outcome of the game.  
    type GameOutcome;
}

#[doc(hidden)]
pub type CommonImpl<Interaction, GameOutcome> = Impl<
    <Interaction as crate::Interaction>::State,
    <Interaction as crate::Interaction>::Action,
    <Interaction as crate::Interaction>::Root,
    Interaction,
    GameOutcome,
>;

#[doc(hidden)]
#[derive_where(Debug)]
pub struct Impl<State, Action, Root, Interaction, GameOutcome> {
    _p: PhantomData<fn() -> (State, Action, Root, Interaction, GameOutcome)>,
}

impl<State, Action, Root, Interaction, GameOutcome> crate::sealed::Sealed
    for Impl<State, Action, Root, Interaction, GameOutcome>
{
}

impl<State, Action, Root, Interaction, GameOutcome> Common
    for Impl<State, Action, Root, Interaction, GameOutcome>
{
    type State = State;
    type Action = Action;
    type Root = Root;
    type Interaction = Interaction;
    type GameOutcome = GameOutcome;
}

pub(crate) type SeqId = i32;