steam-user 0.1.0

Steam User web client for Rust - HTTP-based Steam Community interactions
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

/// Result returned by the
/// [`begin_file_upload`](crate::client::SteamUser::begin_file_upload) call.
#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
pub struct BeginFileUploadResult {
    pub success: i32,
    pub url_host: String,
    pub url_path: String,
    pub use_https: i32,
    pub request_headers: Vec<RequestHeader>,
    pub timestamp: String,
    pub ugcid: String,
    pub hmac: String,
    pub file_name: String,
    pub file_sha: String,
    pub file_image_width: u32,
    pub file_image_height: u32,
    pub file_type: String,
}

/// An HTTP header name/value pair returned as part of a file-upload handshake.
#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
pub struct RequestHeader {
    pub name: String,
    pub value: String,
}

/// Parameters required to commit an uploaded file on the Steam servers.
#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
pub struct CommitFileUploadParams {
    pub file_name: String,
    pub file_sha: String,
    pub file_image_width: u32,
    pub file_image_height: u32,
    pub file_type: String,
    pub ugcid: String,
    pub timestamp: String,
    pub hmac: String,
    pub friend_steamid: Option<String>,
}

/// Response from
/// [`commit_file_upload`](crate::client::SteamUser::commit_file_upload).
#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
pub struct CommitFileUploadResponse {
    pub success: i32,
    pub result: Option<CommitFileUploadResult>,
    pub error: Option<String>,
}

/// Inner result object within [`CommitFileUploadResponse`].
#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
pub struct CommitFileUploadResult {
    pub details: Option<CommitFileDetails>,
}

/// CDN URL details for a successfully committed file upload.
#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
pub struct CommitFileDetails {
    pub url: String,
}

/// Raw wire shape of the `/chat/beginfileupload` response.
#[derive(Debug, Clone, Default, serde::Deserialize)]
#[serde(default)]
pub struct BeginFileUploadRaw {
    pub success: i64,
    pub result: Option<BeginFileUploadResultRaw>,
}

/// Inner `result` object inside [`BeginFileUploadRaw`].
#[derive(Debug, Clone, Default, serde::Deserialize)]
#[serde(default)]
pub struct BeginFileUploadResultRaw {
    pub url_host: String,
    pub url_path: String,
    pub use_https: i64,
    pub timestamp: String,
    pub ugcid: String,
    pub hmac: String,
    pub request_headers: Vec<RequestHeader>,
}

/// Raw wire shape of the `/chat/commitfileupload/` response.
#[derive(Debug, Clone, Default, serde::Deserialize)]
#[serde(default)]
pub struct CommitFileUploadRaw {
    pub success: i64,
    pub error: Option<String>,
    pub result: Option<CommitFileUploadResultRaw>,
}

/// Inner `result` object inside [`CommitFileUploadRaw`].
#[derive(Debug, Clone, Default, serde::Deserialize)]
#[serde(default)]
pub struct CommitFileUploadResultRaw {
    pub details: Option<CommitFileDetails>,
}