modio 0.14.2

Rust interface for integrating https://mod.io - a modding API for game developers
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

use std::collections::BTreeMap;
use std::future::IntoFuture;

use crate::client::Client;
use crate::request::{ArrayParams, Output, RequestBuilder, Route};
use crate::response::ResponseFuture;
use crate::types::id::{GameId, ModId};
use crate::types::mods::MetadataMap;
use crate::types::Message;

/// Add metadata for a mod as searchable key value pairs.
pub struct AddModMetadata<'a> {
    http: &'a Client,
    game_id: GameId,
    mod_id: ModId,
    fields: AddModMetadataFields,
}

struct AddModMetadataFields {
    metadata: MetadataMap,
}

impl AddModMetadataFields {
    fn flatten(&self) -> Vec<String> {
        let sorted = self.metadata.iter().collect::<BTreeMap<_, _>>();
        let mut metadata = Vec::new();
        for (key, values) in sorted {
            for value in values {
                let mut v = key.clone();
                v.push(':');
                v.push_str(value);
                metadata.push(v);
            }
        }
        metadata
    }
}

impl<'a> AddModMetadata<'a> {
    pub(crate) const fn new(
        http: &'a Client,
        game_id: GameId,
        mod_id: ModId,
        metadata: MetadataMap,
    ) -> Self {
        Self {
            http,
            game_id,
            mod_id,
            fields: AddModMetadataFields { metadata },
        }
    }
}

impl IntoFuture for AddModMetadata<'_> {
    type Output = Output<Message>;
    type IntoFuture = ResponseFuture<Message>;

    fn into_future(self) -> Self::IntoFuture {
        let route = Route::AddModMetadata {
            game_id: self.game_id,
            mod_id: self.mod_id,
        };
        let metadata = self.fields.flatten();
        let form = ArrayParams::new("metadata[]", &metadata);
        match RequestBuilder::from_route(&route).form(&form) {
            Ok(req) => self.http.request(req),
            Err(err) => ResponseFuture::failed(err),
        }
    }
}

#[cfg(test)]
mod tests {
    use serde_test::{assert_ser_tokens, Token};

    use super::{AddModMetadataFields, ArrayParams, MetadataMap};

    #[test]
    pub fn serialize_fields() {
        let mut metadata = MetadataMap::new();
        metadata.insert(
            String::from("aaa"),
            vec![String::from("bbb"), String::from("ccc")],
        );
        metadata.insert(
            String::from("ddd"),
            vec![String::from("eee"), String::from("fff")],
        );
        let fields = AddModMetadataFields { metadata };
        let flatten = fields.flatten();
        let params = ArrayParams::new("metadata[]", &flatten);

        assert_ser_tokens(
            &params,
            &[
                Token::Map { len: Some(4) },
                Token::Str("metadata[]"),
                Token::Str("aaa:bbb"),
                Token::Str("metadata[]"),
                Token::Str("aaa:ccc"),
                Token::Str("metadata[]"),
                Token::Str("ddd:eee"),
                Token::Str("metadata[]"),
                Token::Str("ddd:fff"),
                Token::MapEnd,
            ],
        );

        let qs = serde_urlencoded::to_string(&params).unwrap();
        assert_eq!(
            "metadata%5B%5D=aaa%3Abbb&metadata%5B%5D=aaa%3Accc&metadata%5B%5D=ddd%3Aeee&metadata%5B%5D=ddd%3Afff",
            qs
        );
    }
}