stac_api/
fields.rs

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
use serde::{Deserialize, Serialize};
use std::{
    convert::Infallible,
    fmt::{Display, Formatter},
    str::FromStr,
};

/// Include/exclude fields from item collections.
///
/// By default, STAC API endpoints that return Item objects return every field
/// of those Items. However, Item objects can have hundreds of fields, or large
/// geometries, and even smaller Item objects can add up when large numbers of
/// them are in results. Frequently, not all fields in an Item are used, so this
/// specification provides a mechanism for clients to request that servers to
/// explicitly include or exclude certain fields.
#[derive(Clone, Debug, Serialize, Deserialize, Default, PartialEq)]
pub struct Fields {
    /// Fields to include.
    #[serde(skip_serializing_if = "Vec::is_empty")]
    pub include: Vec<String>,

    /// Fields to exclude.
    #[serde(skip_serializing_if = "Vec::is_empty")]
    pub exclude: Vec<String>,
}

impl FromStr for Fields {
    type Err = Infallible;

    fn from_str(s: &str) -> Result<Self, Self::Err> {
        let mut include = Vec::new();
        let mut exclude = Vec::new();
        for field in s.split(',').filter(|s| !s.is_empty()) {
            if let Some(field) = field.strip_prefix('-') {
                exclude.push(field.to_string());
            } else if let Some(field) = field.strip_prefix('+') {
                include.push(field.to_string());
            } else {
                include.push(field.to_string());
            }
        }
        Ok(Fields { include, exclude })
    }
}

impl Display for Fields {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        let mut fields = Vec::new();
        for include in &self.include {
            fields.push(include.to_string());
        }
        for exclude in &self.exclude {
            fields.push(format!("-{}", exclude));
        }
        write!(f, "{}", fields.join(","))
    }
}

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

    #[test]
    fn empty() {
        assert_eq!(Fields::default(), "".parse().unwrap());
    }

    #[test]
    fn plus() {
        assert_eq!(
            Fields {
                include: vec!["foo".to_string()],
                exclude: Vec::new(),
            },
            "+foo".parse().unwrap()
        );
    }

    #[test]
    fn includes() {
        assert_eq!(
            Fields {
                include: vec![
                    "id".to_string(),
                    "type".to_string(),
                    "geometry".to_string(),
                    "bbox".to_string(),
                    "properties".to_string(),
                    "links".to_string(),
                    "assets".to_string(),
                ],
                exclude: Vec::new()
            },
            "id,type,geometry,bbox,properties,links,assets"
                .parse()
                .unwrap()
        );
        assert_eq!(
            Fields {
                include: vec![
                    "id".to_string(),
                    "type".to_string(),
                    "geometry".to_string(),
                    "bbox".to_string(),
                    "properties".to_string(),
                    "links".to_string(),
                    "assets".to_string(),
                ],
                exclude: Vec::new()
            }
            .to_string(),
            "id,type,geometry,bbox,properties,links,assets"
        )
    }

    #[test]
    fn exclude() {
        assert_eq!(
            Fields {
                include: Vec::new(),
                exclude: vec!["geometry".to_string()]
            },
            "-geometry".parse().unwrap()
        );
        assert_eq!(
            Fields {
                include: Vec::new(),
                exclude: vec!["geometry".to_string()]
            }
            .to_string(),
            "-geometry"
        );
    }
}