bombay-engine 0.1.0

Actor-independent runtime engine composing Bombay Behavior, Transition, and Machine Executor.
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

//! Runtime port: events in, transition effects out, then explicit retirement.

use core::future::Future;

/// Gives a process protocol its live or simulated meaning.
///
/// Unlike narrower ingress ports, an environment also owns effect
/// interpretation and the ordering between input and effects.
pub trait Environment {
    /// Events supplied to the behavior.
    type Event;
    /// Effects emitted by the behavior in one transition.
    type Effect;
    /// Failure while interpreting an effect.
    type Error;

    /// Produce the next event, or `None` when the source is closed.
    fn next(&mut self) -> impl Future<Output = Option<Self::Event>> + Send;

    /// Interpret one successful transition's complete effect.
    fn interpret(
        &mut self,
        effect: Self::Effect,
    ) -> impl Future<Output = Result<(), Self::Error>> + Send;

    /// Retire resources that must be gone before terminal publication.
    fn retire(&mut self) -> impl Future<Output = ()> + Send;
}