net-mel 0.10.0

Mélodium network utilities library
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
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
use melodium_core::{executive::*, *};
use melodium_macro::{check, mel_data, mel_function, mel_treatment};
use std::str::FromStr;
use std::sync::Arc;

/// IP data.
///
/// `Ip` data type contains a valid IP v4 or v6.
///
/// ℹ️ _Valid IP_ means the data contained makes sense as IP, not that it is reacheable.
#[mel_data(traits(ToString TryToString Display))]
#[derive(Debug, Clone, Serialize)]
pub struct Ip(pub std::net::IpAddr);

impl ToString for Ip {
    fn to_string(&self) -> string {
        self.0.to_string()
    }
}

impl TryToString for Ip {
    fn try_to_string(&self) -> Option<string> {
        Some(self.0.to_string())
    }
}

impl Display for Ip {
    fn display(&self, f: &mut core::fmt::Formatter<'_>) -> Result<(), core::fmt::Error> {
        write!(f, "{}", &self.0)
    }
}

/// IPv4 data.
///
/// `Ipv4` data type contains a valid IP v4.
///
/// ℹ️ _Valid IP v4_ means the data contained makes sense as IP, not that it is reacheable.
#[mel_data(traits(ToString TryToString Display))]
#[derive(Debug, Clone, Serialize)]
pub struct Ipv4(pub std::net::Ipv4Addr);

impl ToString for Ipv4 {
    fn to_string(&self) -> string {
        self.0.to_string()
    }
}

impl TryToString for Ipv4 {
    fn try_to_string(&self) -> Option<string> {
        Some(self.0.to_string())
    }
}

impl Display for Ipv4 {
    fn display(&self, f: &mut core::fmt::Formatter<'_>) -> Result<(), core::fmt::Error> {
        write!(f, "{}", &self.0)
    }
}

/// Makes IPv4 generic.
#[mel_function]
pub fn from_ipv4(ipv4: Ipv4) -> Ip {
    Ip(std::net::IpAddr::V4(ipv4.0))
}

/// Makes IPv6 generic.
#[mel_function]
pub fn from_ipv6(ipv6: Ipv6) -> Ip {
    Ip(std::net::IpAddr::V6(ipv6.0))
}

/// Turn stream of IPv4 into generic IP
#[mel_treatment(
    input ipv4 Stream<Ipv4>
    output ip Stream<Ip>
)]
pub async fn from_ipv4() {
    while let Ok(ips) = ipv4
        .recv_many()
        .await
        .map(|values| Into::<VecDeque<Value>>::into(values))
    {
        check!(
            ip.send_many(TransmissionValue::Other(
                ips.into_iter()
                    .map(|ip| Value::Data(Arc::new(Ip(std::net::IpAddr::V4(
                        GetData::<Arc<dyn Data>>::try_data(ip)
                            .unwrap()
                            .downcast_arc::<Ipv4>()
                            .unwrap()
                            .0
                    )))))
                    .collect()
            ))
            .await
        )
    }
}

/// Turn stream of IPv6 into generic IP
#[mel_treatment(
    input ipv6 Stream<Ipv6>
    output ip Stream<Ip>
)]
pub async fn from_ipv6() {
    while let Ok(ips) = ipv6
        .recv_many()
        .await
        .map(|values| Into::<VecDeque<Value>>::into(values))
    {
        check!(
            ip.send_many(TransmissionValue::Other(
                ips.into_iter()
                    .map(|ip| Value::Data(Arc::new(Ip(std::net::IpAddr::V6(
                        GetData::<Arc<dyn Data>>::try_data(ip)
                            .unwrap()
                            .downcast_arc::<Ipv6>()
                            .unwrap()
                            .0
                    )))))
                    .collect()
            ))
            .await
        )
    }
}

/// Get the IPv4 of generic IP.
#[mel_function]
pub fn as_ipv4(ip: Ip) -> Option<Ipv4> {
    if let std::net::IpAddr::V4(ip) = ip.0 {
        Some(Ipv4(ip))
    } else {
        None
    }
}

/// Get the IPv6 of generic IP.
#[mel_function]
pub fn as_ipv6(ip: Ip) -> Option<Ipv6> {
    if let std::net::IpAddr::V6(ip) = ip.0 {
        Some(Ipv6(ip))
    } else {
        None
    }
}

/// Get the IPv4 from generic IP stream
#[mel_treatment(
    input ip Stream<Ip>
    output ipv4 Stream<Option<Ipv4>>
)]
pub async fn as_ipv4() {
    while let Ok(ips) = ip
        .recv_many()
        .await
        .map(|values| Into::<VecDeque<Value>>::into(values))
    {
        check!(
            ipv4.send_many(TransmissionValue::Other(
                ips.into_iter()
                    .map(|ip| Value::Option(
                        match GetData::<Arc<dyn Data>>::try_data(ip)
                            .unwrap()
                            .downcast_arc::<Ip>()
                            .unwrap()
                            .0
                        {
                            std::net::IpAddr::V4(ip) =>
                                Some(Box::new(Value::Data(Arc::new(Ipv4(ip))))),
                            std::net::IpAddr::V6(_) => None,
                        }
                    ))
                    .collect()
            ))
            .await
        )
    }
}

/// Get the IPv6 from generic IP stream
#[mel_treatment(
    input ip Stream<Ip>
    output ipv6 Stream<Option<Ipv6>>
)]
pub async fn as_ipv6() {
    while let Ok(ips) = ip
        .recv_many()
        .await
        .map(|values| Into::<VecDeque<Value>>::into(values))
    {
        check!(
            ipv6.send_many(TransmissionValue::Other(
                ips.into_iter()
                    .map(|ip| Value::Option(
                        match GetData::<Arc<dyn Data>>::try_data(ip)
                            .unwrap()
                            .downcast_arc::<Ip>()
                            .unwrap()
                            .0
                        {
                            std::net::IpAddr::V4(_) => None,
                            std::net::IpAddr::V6(ip) =>
                                Some(Box::new(Value::Data(Arc::new(Ipv6(ip))))),
                        }
                    ))
                    .collect()
            ))
            .await
        )
    }
}

/// Tells if generic IP is IPv4.
#[mel_function]
pub fn is_ipv4(ip: Ip) -> bool {
    ip.0.is_ipv4()
}

/// Tells if generic IP is IPv6.
#[mel_function]
pub fn is_ipv6(ip: Ip) -> bool {
    ip.0.is_ipv6()
}

/// Tells for IP in stream if they are v4
#[mel_treatment(
    input ip Stream<Ip>
    output ipv4 Stream<bool>
)]
pub async fn is_ipv4() {
    while let Ok(ips) = ip
        .recv_many()
        .await
        .map(|values| Into::<VecDeque<Value>>::into(values))
    {
        check!(
            ipv4.send_many(TransmissionValue::Bool(
                ips.into_iter()
                    .map(|ip| GetData::<Arc<dyn Data>>::try_data(ip)
                        .unwrap()
                        .downcast_arc::<Ip>()
                        .unwrap()
                        .0
                        .is_ipv4())
                    .collect()
            ))
            .await
        )
    }
}

/// Tells for IP in stream if they are v6
#[mel_treatment(
    input ip Stream<Ip>
    output ipv6 Stream<bool>
)]
pub async fn is_ipv6() {
    while let Ok(ips) = ip
        .recv_many()
        .await
        .map(|values| Into::<VecDeque<Value>>::into(values))
    {
        check!(
            ipv6.send_many(TransmissionValue::Bool(
                ips.into_iter()
                    .map(|ip| GetData::<Arc<dyn Data>>::try_data(ip)
                        .unwrap()
                        .downcast_arc::<Ip>()
                        .unwrap()
                        .0
                        .is_ipv6())
                    .collect()
            ))
            .await
        )
    }
}

/// Creates new IPv4.
#[mel_function]
pub fn ipv4(a: u8, b: u8, c: u8, d: u8) -> Ipv4 {
    Ipv4(std::net::Ipv4Addr::new(a, b, c, d))
}

/// Parse string into IPv4.
#[mel_function]
pub fn to_ipv4(text: string) -> Option<Ipv4> {
    std::net::Ipv4Addr::from_str(&text).ok().map(|ip| Ipv4(ip))
}

/// Parse string into IPv4.
///
/// `ipv4` contains some `Ipv4` if input `text` contains valid ip, else none.
#[mel_treatment(
    input text Stream<string>
    output ipv4 Stream<Option<Ipv4>>
)]
pub async fn to_ipv4() {
    while let Ok(text) = text
        .recv_many()
        .await
        .map(|values| TryInto::<Vec<string>>::try_into(values).unwrap())
    {
        check!(
            ipv4.send_many(TransmissionValue::Other(
                text.iter()
                    .map(|t| Value::Option(
                        std::net::Ipv4Addr::from_str(t)
                            .ok()
                            .map(|ip| Box::new(Value::Data(Arc::new(Ipv4(ip)))))
                    ))
                    .collect()
            ))
            .await
        )
    }
}

/// Return IPv4 localhost.
#[mel_function]
pub fn localhost_ipv4() -> Ipv4 {
    Ipv4(std::net::Ipv4Addr::LOCALHOST)
}

/// Return IPv4 unspecified.
#[mel_function]
pub fn unspecified_ipv4() -> Ipv4 {
    Ipv4(std::net::Ipv4Addr::UNSPECIFIED)
}

/// IPv6 data.
///
/// `Ipv6` data type contains a valid IP v6.
///
/// ℹ️ _Valid IP v6_ means the data contained makes sense as IP, not that it is reacheable.
#[mel_data(traits(ToString TryToString Display))]
#[derive(Debug, Clone, Serialize)]
pub struct Ipv6(pub std::net::Ipv6Addr);

impl ToString for Ipv6 {
    fn to_string(&self) -> string {
        self.0.to_string()
    }
}

impl TryToString for Ipv6 {
    fn try_to_string(&self) -> Option<string> {
        Some(self.0.to_string())
    }
}

impl Display for Ipv6 {
    fn display(&self, f: &mut core::fmt::Formatter<'_>) -> Result<(), core::fmt::Error> {
        write!(f, "{}", &self.0)
    }
}

/// Creates new IPv6.
#[mel_function]
pub fn ipv6(a: u16, b: u16, c: u16, d: u16, e: u16, f: u16, g: u16, h: u16) -> Ipv6 {
    Ipv6(std::net::Ipv6Addr::new(a, b, c, d, e, f, g, h))
}

/// Parse string into IPv6.
#[mel_function]
pub fn to_ipv6(text: string) -> Option<Ipv6> {
    std::net::Ipv6Addr::from_str(&text).ok().map(|ip| Ipv6(ip))
}

/// Parse string into IPv6.
///
/// `ipv6` contains some `Ipv6` if input `text` contains valid ip, else none.
#[mel_treatment(
    input text Stream<string>
    output ipv6 Stream<Option<Ipv6>>
)]
pub async fn to_ipv6() {
    while let Ok(text) = text
        .recv_many()
        .await
        .map(|values| TryInto::<Vec<string>>::try_into(values).unwrap())
    {
        check!(
            ipv6.send_many(TransmissionValue::Other(
                text.iter()
                    .map(|t| Value::Option(
                        std::net::Ipv6Addr::from_str(t)
                            .ok()
                            .map(|ip| Box::new(Value::Data(Arc::new(Ipv6(ip)))))
                    ))
                    .collect()
            ))
            .await
        )
    }
}

/// Return IPv6 localhost.
#[mel_function]
pub fn localhost_ipv6() -> Ipv6 {
    Ipv6(std::net::Ipv6Addr::LOCALHOST)
}

/// Return IPv6 unspecified.
#[mel_function]
pub fn unspecified_ipv6() -> Ipv6 {
    Ipv6(std::net::Ipv6Addr::UNSPECIFIED)
}