flo_scene 0.2.0

Entity-messaging system for composing large programs from small programs
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

use crate::host::scene_message::*;
use crate::host::stream_target::*;
use crate::host::programs::*;

use serde::*;

use std::marker::{PhantomData};
use std::sync::*;

///
/// The RunCommand is a query request that will run a named command with a parameter, returning the result as a stream of responses to a target
///
#[derive(Clone, PartialEq, Eq, Debug)]
#[derive(Serialize, Deserialize)]
pub struct RunCommand<TParameter, TResponse> {
    /// Where the responses to the command should be sent
    target:     StreamTarget,

    /// The name of the command to run
    name:       String,

    /// Data to send to the command
    parameter:  TParameter,

    /// Phantom data for the response type
    response:   PhantomData<Mutex<TResponse>>,
}

impl<TParameter, TResponse> RunCommand<TParameter, TResponse>
where
    TParameter: Unpin + Send,
    TResponse:  Unpin + Send
{
    ///
    /// Creates a new 'run command' request. The command with the specified name will be run, and will send its response to the target.
    ///
    pub fn new(target: impl Into<StreamTarget>, name: impl Into<String>, parameter: impl Into<TParameter>) -> Self {
        Self {
            target:     target.into(),
            name:       name.into(),
            parameter:  parameter.into(),
            response:   PhantomData,
        }
    }

    ///
    /// Returns the program that the response to the command should be setn to
    ///
    pub fn target(&self) -> StreamTarget {
        self.target.clone()
    }

    ///
    /// The name of the command that is to be run
    ///
    pub fn name(&self) -> &str {
        &self.name
    }

    ///
    /// The parameter to the command
    ///
    pub fn parameter(&self) -> &TParameter {
        &self.parameter
    }
}

impl<TParameter, TResponse> SceneMessage for RunCommand<TParameter, TResponse>
where
    TParameter: 'static + Unpin + Send + Serialize,
    TResponse:  'static + Unpin + Send + Serialize,
    for<'de> TParameter: Deserialize<'de>,
    for<'de> TResponse: Deserialize<'de>
{
    #[inline]
    fn message_type_name() -> String { format!("flo_scene::RunCommand<{}, {}>", std::any::type_name::<TParameter>(), std::any::type_name::<TResponse>()) }
}

impl<TParameter, TResponse> QueryRequest for RunCommand<TParameter, TResponse> 
where
    TParameter: 'static + Unpin + Send + Serialize,
    TResponse:  'static + Unpin + Send + Serialize,
    for<'de> TParameter: Deserialize<'de>,
    for<'de> TResponse: Deserialize<'de>
{
    type ResponseData = TResponse;

    fn with_new_target(self, new_target: StreamTarget) -> Self {
        RunCommand {
            target:     new_target,
            name:       self.name,
            parameter:  self.parameter,
            response:   PhantomData
        }
    }
}