nominal 0.5.1

Automate Nominal workflows in Rust
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

use nominal_api::objects::scout::datasource::connection::api::{
    Connection as ApiConnection, UpdateConnectionRequest,
};

use crate::core::rid::rid_to_string;

/// Represents a connection in Nominal.
///
/// Connections are data sources that stream or otherwise provide live data,
/// such as TimescaleDB, InfluxDB, or Nominal streaming connections.
#[derive(Debug, Clone)]
pub struct Connection {
    rid: String,
    name: String,
    description: Option<String>,
}

impl Connection {
    pub fn rid(&self) -> &str {
        &self.rid
    }

    pub fn name(&self) -> &str {
        &self.name
    }

    pub fn description(&self) -> Option<&str> {
        self.description.as_deref()
    }

    pub(crate) fn from_conjure(connection: ApiConnection) -> Self {
        Self {
            rid: rid_to_string(connection.rid()),
            name: connection.display_name().to_string(),
            description: connection
                .description()
                .filter(|s| !s.is_empty())
                .map(|s| s.to_string()),
        }
    }
}

/// An update to connection metadata. Only fields that are set will be changed.
#[derive(Debug, Default, Clone)]
pub struct ConnectionUpdate {
    name: Option<String>,
    description: Option<String>,
}

impl ConnectionUpdate {
    #[must_use]
    pub fn new() -> Self {
        Self::default()
    }

    #[must_use]
    pub fn name(mut self, value: impl Into<String>) -> Self {
        self.name = Some(value.into());
        self
    }

    #[must_use]
    pub fn description(mut self, value: impl Into<String>) -> Self {
        self.description = Some(value.into());
        self
    }

    pub(crate) fn into_request(self) -> UpdateConnectionRequest {
        let ConnectionUpdate { name, description } = self;
        let mut b = UpdateConnectionRequest::builder();
        if let Some(n) = name {
            b = b.name(n);
        }
        if let Some(d) = description {
            b = b.description(d);
        }
        b.build()
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn update_empty() {
        let req = ConnectionUpdate::new().into_request();
        assert!(req.name().is_none());
        assert!(req.description().is_none());
    }

    #[test]
    fn update_name_and_description() {
        let req = ConnectionUpdate::new()
            .name("My Connection")
            .description("desc")
            .into_request();
        assert_eq!(req.name(), Some("My Connection"));
        assert_eq!(req.description(), Some("desc"));
    }
}