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
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

use std::future::IntoFuture;

use serde_derive::Serialize;

use crate::client::Client;
use crate::request::{Output, RequestBuilder, Route};
use crate::response::ResponseFuture;
use crate::types::id::{GameId, ModId};
use crate::types::mods::{CommunityOptions, CreditOptions, MaturityOption, Mod};

/// Edit details for a mod.
pub struct EditMod<'a> {
    http: &'a Client,
    game_id: GameId,
    mod_id: ModId,
    fields: EditModFields<'a>,
}

#[derive(Serialize)]
struct EditModFields<'a> {
    #[serde(skip_serializing_if = "Option::is_none")]
    status: Option<u8>,
    #[serde(skip_serializing_if = "Option::is_none")]
    visibility: Option<u8>,
    #[serde(skip_serializing_if = "Option::is_none")]
    name: Option<&'a str>,
    #[serde(skip_serializing_if = "Option::is_none")]
    name_id: Option<&'a str>,
    #[serde(skip_serializing_if = "Option::is_none")]
    summary: Option<&'a str>,
    #[serde(skip_serializing_if = "Option::is_none")]
    description: Option<&'a str>,
    #[serde(skip_serializing_if = "Option::is_none")]
    homepage_url: Option<&'a str>,
    #[serde(skip_serializing_if = "Option::is_none")]
    stock: Option<u32>,
    #[serde(skip_serializing_if = "Option::is_none")]
    maturity_option: Option<MaturityOption>,
    #[serde(skip_serializing_if = "Option::is_none")]
    community_options: Option<CommunityOptions>,
    #[serde(skip_serializing_if = "Option::is_none")]
    credit_options: Option<CreditOptions>,
    #[serde(skip_serializing_if = "Option::is_none")]
    metadata_blob: Option<&'a str>,
    #[serde(skip_serializing_if = "Option::is_none")]
    tags: Option<&'a [&'a str]>,
}

impl<'a> EditMod<'a> {
    pub(crate) const fn new(http: &'a Client, game_id: GameId, mod_id: ModId) -> Self {
        Self {
            http,
            game_id,
            mod_id,
            fields: EditModFields {
                status: None,
                visibility: None,
                name: None,
                name_id: None,
                summary: None,
                description: None,
                homepage_url: None,
                stock: None,
                maturity_option: None,
                community_options: None,
                credit_options: None,
                metadata_blob: None,
                tags: None,
            },
        }
    }

    pub const fn name(mut self, name: &'a str) -> Self {
        self.fields.name = Some(name);
        self
    }

    pub const fn name_id(mut self, name_id: &'a str) -> Self {
        self.fields.name_id = Some(name_id);
        self
    }

    pub const fn summary(mut self, summary: &'a str) -> Self {
        self.fields.summary = Some(summary);
        self
    }

    pub const fn description(mut self, description: &'a str) -> Self {
        self.fields.description = Some(description);
        self
    }

    pub const fn homepage_url(mut self, homepage_url: &'a str) -> Self {
        self.fields.homepage_url = Some(homepage_url);
        self
    }

    pub const fn stock(mut self, stock: u32) -> Self {
        self.fields.stock = Some(stock);
        self
    }

    pub const fn maturity_option(mut self, option: MaturityOption) -> Self {
        self.fields.maturity_option = Some(option);
        self
    }

    pub const fn community_options(mut self, options: CommunityOptions) -> Self {
        self.fields.community_options = Some(options);
        self
    }

    pub const fn credit_options(mut self, options: CreditOptions) -> Self {
        self.fields.credit_options = Some(options);
        self
    }

    pub const fn metadata_blob(mut self, metadata: &'a str) -> Self {
        self.fields.metadata_blob = Some(metadata);
        self
    }

    pub const fn tags(mut self, tags: &'a [&'a str]) -> Self {
        self.fields.tags = Some(tags);
        self
    }

    pub const fn status(mut self, status: u8) -> Self {
        self.fields.status = Some(status);
        self
    }

    pub const fn visible(mut self, visible: bool) -> Self {
        self.fields.visibility = Some(if visible { 1 } else { 0 });
        self
    }
}

impl IntoFuture for EditMod<'_> {
    type Output = Output<Mod>;
    type IntoFuture = ResponseFuture<Mod>;

    fn into_future(self) -> Self::IntoFuture {
        let route = Route::EditMod {
            game_id: self.game_id,
            mod_id: self.mod_id,
        };
        match RequestBuilder::from_route(&route).form(&self.fields) {
            Ok(req) => self.http.request(req),
            Err(err) => ResponseFuture::failed(err),
        }
    }
}