cognite-sdk 0.6.2

SDK for the Cognite Data Fusion API
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 std::fmt::Display;

use crate::Partition;

/// Trait for query parameters.
pub trait IntoParams {
    /// Convert self to a list of query parameter tuples.
    fn into_params(self) -> Vec<(String, String)>;
}

impl IntoParams for Vec<(String, String)> {
    fn into_params(self) -> Vec<(String, String)> {
        self
    }
}

/// Push the item given in `item` to the query with name `name` if it is Some.
pub fn to_query<T>(name: &str, item: &Option<T>, params: &mut Vec<(String, String)>)
where
    T: Display,
{
    if let Some(it) = item {
        params.push((name.to_string(), it.to_string()));
    }
}

/// Push a list of items to the query with name `name` if `item` is `Some`.
pub fn to_query_vec(name: &str, item: &Option<Vec<String>>, params: &mut Vec<(String, String)>) {
    if let Some(it) = item {
        params.push((
            name.to_string(),
            format!(
                "[{}]",
                it.iter()
                    .map(|val| { format!("\"{val}\"") })
                    .collect::<Vec<String>>()
                    .join(", ")
            ),
        ));
    }
}

/// Push a list of numbers to the query with name `name` if `item` is `Some`.
pub fn to_query_vec_i64(name: &str, item: &Option<Vec<i64>>, params: &mut Vec<(String, String)>) {
    if let Some(it) = item {
        params.push((
            name.to_string(),
            format!(
                "[{}]",
                it.iter()
                    .map(|val| { format!("{val}") })
                    .collect::<Vec<String>>()
                    .join(", ")
            ),
        ))
    }
}

/// Simple query with limit and cursor.
#[derive(Debug, Default, Clone)]
pub struct LimitCursorQuery {
    /// Maximum number of results to return.
    pub limit: Option<i32>,
    /// Cursor for pagination.
    pub cursor: Option<String>,
}

impl IntoParams for LimitCursorQuery {
    fn into_params(self) -> Vec<(String, String)> {
        let mut params = Vec::<(String, String)>::new();
        to_query("limit", &self.limit, &mut params);
        to_query("cursor", &self.cursor, &mut params);
        params
    }
}

/// Query with limt, cursor, and partition.
#[derive(Debug, Default, Clone)]
pub struct LimitCursorPartitionQuery {
    /// Maximum number of results to return.
    pub limit: Option<i32>,
    /// Cursor for pagination.
    pub cursor: Option<String>,
    /// Partition count and number.
    pub partition: Option<Partition>,
}

impl IntoParams for LimitCursorPartitionQuery {
    fn into_params(self) -> Vec<(String, String)> {
        let mut params = Vec::<(String, String)>::new();
        to_query("limit", &self.limit, &mut params);
        to_query("cursor", &self.cursor, &mut params);
        to_query("partition", &self.partition, &mut params);
        params
    }
}