flarrow-layout 0.3.1

flarrow (flow + arrow) is a rust runtime/framework for building dataflow applications.
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
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169

use std::collections::{HashMap, HashSet};

use crate::prelude::*;

/// Represents a node
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct NodeLayout {
    pub label: String,
    pub uuid: Uuid,
}

impl NodeLayout {
    /// Creates a new node layout with a unique UUID v4
    pub fn new(label: impl Into<String>) -> Self {
        NodeLayout {
            label: label.into(),
            uuid: Uuid::new_v4(),
        }
    }

    /// Creates a new input layout with a unique UUID v3 based on the node's UUID and input label
    pub fn input(&self, input: impl Into<String>) -> InputLayout {
        let label = input.into();
        InputLayout {
            uuid: Uuid::new_v3(&self.uuid, label.as_bytes()),
            label,
        }
    }

    /// Creates a new output layout with a unique UUID v3 based on the node's UUID and output label
    pub fn output(&self, output: impl Into<String>) -> OutputLayout {
        let label = output.into();
        OutputLayout {
            uuid: Uuid::new_v3(&self.uuid, label.as_bytes()),
            label,
        }
    }

    /// Creates a new query layout with a unique UUID v3 based on the node's UUID and query label
    pub fn query(&self, query: impl Into<String>) -> QueryLayout {
        let label = query.into();
        QueryLayout {
            uuid: Uuid::new_v3(&self.uuid, label.as_bytes()),
            label,
        }
    }

    /// Creates a new queryable layout with a unique UUID v3 based on the node's UUID and queryable label
    pub fn queryable(&self, queryable: impl Into<String>) -> QueryableLayout {
        let label = queryable.into();
        QueryableLayout {
            uuid: Uuid::new_v3(&self.uuid, label.as_bytes()),
            label,
        }
    }
}

/// This is the object passed to the user's lambda function to build the node's IO layout
pub struct NodeIOBuilder {
    /// The node layout this io builder is applied to
    pub layout: NodeLayout,

    /// The runtime only cares about input UUIDs
    pub inputs: HashSet<Uuid>,
    /// The runtime only cares about output UUIDs
    pub outputs: HashSet<Uuid>,
    /// The runtime only cares about query UUIDs
    pub queries: HashSet<Uuid>,
    /// The runtime only cares about queryable UUIDs
    pub queryables: HashSet<Uuid>,

    /// Labels for the node's IO, useful for debugging and visualization
    pub labels: HashMap<Uuid, String>,
}

impl NodeIOBuilder {
    pub fn new(layout: &NodeLayout) -> Self {
        Self {
            layout: layout.clone(),

            inputs: HashSet::new(),
            outputs: HashSet::new(),
            queryables: HashSet::new(),
            queries: HashSet::new(),

            labels: HashMap::new(),
        }
    }

    /// Creates a new input layout with the given label
    pub fn input(&mut self, input: impl Into<String>) -> IOLayout {
        let label: String = input.into();
        let layout = self.layout.input(&label);

        self.inputs.insert(layout.uuid);

        self.labels.insert(layout.uuid, label.clone());

        tracing::debug!(
            "Node '{}' (uuid: {}) added input layout with label: '{}' (uuid: {})",
            self.layout.label,
            self.layout.uuid,
            label,
            layout.uuid
        );

        layout.into()
    }

    /// Creates a new output layout with the given label
    pub fn output(&mut self, output: impl Into<String>) -> IOLayout {
        let label: String = output.into();
        let layout = self.layout.output(&label);

        self.outputs.insert(layout.uuid);

        self.labels.insert(layout.uuid, label.clone());

        tracing::debug!(
            "Node '{}' (uuid: {}) added output layout with label: '{}' (uuid: {})",
            self.layout.label,
            self.layout.uuid,
            label,
            layout.uuid
        );

        layout.into()
    }

    /// Creates a new query layout with the given label
    pub fn query(&mut self, query: impl Into<String>) -> IOLayout {
        let label: String = query.into();
        let layout = self.layout.query(&label);

        self.queries.insert(layout.uuid);

        self.labels.insert(layout.uuid, label.clone());

        tracing::debug!(
            "Node '{}' (uuid: {}) added query layout with label: '{}' (uuid: {})",
            self.layout.label,
            self.layout.uuid,
            label,
            layout.uuid
        );

        layout.into()
    }

    /// Creates a new queryable layout with the given label
    pub fn queryable(&mut self, queryable: impl Into<String>) -> IOLayout {
        let label: String = queryable.into();
        let layout = self.layout.queryable(&label);

        self.queryables.insert(layout.uuid);

        self.labels.insert(layout.uuid, label.clone());

        tracing::debug!(
            "Node '{}' (uuid: {}) added queryable layout with label: '{}' (uuid: {})",
            self.layout.label,
            self.layout.uuid,
            label,
            layout.uuid
        );

        layout.into()
    }
}