pipecircuit 0.0.16

Correct. Robust. Fast. Portable.
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
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106

use core::any::type_name;
use core::mem::size_of;

use crate::{
    FlowObservation, FlowObserver, Participant, Pipe, StateMachine, StepInputOf, Switchboard,
    TransportTo,
};

pub struct PipeFlow<Observer> {
    observer: Observer,
}

impl<Observer> PipeFlow<Observer> {
    pub const fn new(observer: Observer) -> Self {
        Self { observer }
    }

    pub const fn observer(&self) -> &Observer {
        &self.observer
    }

    pub const fn observer_mut(&mut self) -> &mut Observer {
        &mut self.observer
    }

    pub fn into_observer(self) -> Observer {
        self.observer
    }
}

impl<Observer: FlowObserver> PipeFlow<Observer> {
    #[must_use = "pipe outcomes must be routed or settled"]
    #[inline(always)]
    pub fn send_through<'transport, 'message, Destination, InstalledTransport>(
        &mut self,
        pipe: &'transport mut Pipe<Destination, InstalledTransport>,
        input: Destination::In<'message>,
    ) -> InstalledTransport::Outcome<'transport, 'message>
    where
        Destination: Participant,
        InstalledTransport: TransportTo<Destination>,
    {
        self.observer.observe(FlowObservation::PipeSendBegan {
            participant: type_name::<Destination>(),
            input: type_name::<Destination::In<'message>>(),
            transport: type_name::<InstalledTransport>(),
            input_representation_bytes: size_of::<Destination::In<'message>>(),
        });
        let outcome = pipe.send(input);
        self.observer.observe(FlowObservation::PipeSendCompleted {
            participant: type_name::<Destination>(),
            transport: type_name::<InstalledTransport>(),
            outcome: type_name::<InstalledTransport::Outcome<'transport, 'message>>(),
            output_representation_bytes: size_of::<
                InstalledTransport::Outcome<'transport, 'message>,
            >(),
        });
        outcome
    }

    #[must_use = "participant step outcomes must be routed or settled"]
    #[inline(always)]
    pub fn step<Machine, Input>(&mut self, machine: &mut Machine, input: Input) -> Input::Outcome
    where
        Machine: StateMachine,
        Input: StepInputOf<Machine>,
    {
        self.observer
            .observe(FlowObservation::ParticipantStepBegan {
                participant: type_name::<Machine>(),
                input: type_name::<Input>(),
                input_representation_bytes: size_of::<Input>(),
            });
        let outcome = machine.step(input);
        self.observer
            .observe(FlowObservation::ParticipantStepCompleted {
                participant: type_name::<Machine>(),
                outcome: type_name::<Input::Outcome>(),
                output_representation_bytes: size_of::<Input::Outcome>(),
            });
        outcome
    }

    #[must_use = "switchboard route outcomes must be routed or settled"]
    #[inline(always)]
    pub fn route<'message, Board: Switchboard>(
        &mut self,
        switchboard: &mut Board,
        input: Board::From<'message>,
    ) -> Board::To<'message> {
        self.observer
            .observe(FlowObservation::SwitchboardRouteBegan {
                switchboard: type_name::<Board>(),
                input: type_name::<Board::From<'message>>(),
                input_representation_bytes: size_of::<Board::From<'message>>(),
            });
        let output = switchboard.route(input);
        self.observer
            .observe(FlowObservation::SwitchboardRouteCompleted {
                switchboard: type_name::<Board>(),
                output: type_name::<Board::To<'message>>(),
                output_representation_bytes: size_of::<Board::To<'message>>(),
            });
        output
    }
}