rs-flow 0.5.0

Create flows to execute based in components created and yours connections
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

use std::collections::{HashMap, VecDeque};
use std::sync::Arc;

use crate::context::global::Global;

use crate::component::{Id, Type};
use crate::error::{FlowError, Result};
use crate::package::Package;
use crate::ports::PortId;
use crate::prelude::Component;


///
/// Provide a interface to send and recieve [Package]'s to/from others [Component]'s
/// and access to read and modify the global data of the [Flow](crate::flow::Flow).
/// 
pub struct Ctx<G: Send + Sync> {
    pub(crate) id: Id,
    pub(crate) ty: Type,
    pub(crate) send: HashMap<PortId, VecDeque<Package>>,
    pub(crate) receive: HashMap<PortId, VecDeque<Package>>,
    pub(crate) consumed: bool,

    global: Arc<Global<G>>,
}

impl<G> Ctx<G> 
    where G: Send + Sync + 'static
{

    pub(crate) fn from(component: &Component<G>, global: &Arc<Global<G>>) -> Self {
        let send = HashMap::from_iter(
            component.data.outputs().0.iter().map(|port| (port.port, VecDeque::new()))
        );
        let receive = HashMap::from_iter(
            component.data.inputs().0.iter().map(|port| (port.port, VecDeque::new()))
        );
        Self {
            id: component.id,
            ty: component.ty,
            send,
            receive,
            consumed: false,
            global: global.clone(),
        }
    }
    
    /// 
    /// Recieve a [Package] from a [Port](crate::ports::Port)
    /// 
    /// # Panics
    /// 
    /// Panic if recieve from a [Input](crate::ports::Inputs) Port that not exist in this [Component]
    /// 
    pub fn receive(&mut self, in_port: PortId) -> Option<Package> {
        let package = self.receive.get_mut(&in_port)
            .ok_or(FlowError::QueueNotCreated { 
                component: self.id, port: in_port 
            })
            .unwrap()
            .pop_front();

        self.consumed = true;
        
        package
    }
    
    /// Send a [Package] to a [Port](crate::ports::Port), if one [Component] is connected to this port than he
    /// can recieve that [Package] sent.
    ///  
    /// If more than one components is connected in this port, each one recieve a copy of this [Package].
    ///  
    /// # Panics
    /// 
    /// Panic if send to a [Output](crate::ports::Outputs) Port that not exist in this [Component]
    /// 
    pub fn send(&mut self, out_port: PortId, package: Package) {
        self.send.get_mut(&out_port)
            .ok_or(FlowError::QueueNotCreated { 
                component: self.id, port: out_port 
            })
            .unwrap()
            .push_front(package);
    }
    

    /// Interface tha provide a way to read the global data of the [Flow](crate::flow::Flow)
    pub fn with_global<R>(&self, call: impl FnOnce(&G) -> R) -> Result<R> {
        self.global.with_global(call)
    }
    
    /// Interface tha provide a way to read and modify the global data of the [Flow](crate::flow::Flow)
    pub fn with_mut_global<R>(&self,  call: impl FnOnce(&mut G) -> R) -> Result<R> {
        self.global.with_mut_global(call)
    }

}