chilloutvr 0.6.0

Unofficial rust types of ChilloutVR's 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
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};

#[cfg(feature = "http")]
use super::AssetBaseWithCategories;
#[cfg(feature = "http")]
use crate::model::{AssetBase, FeaturedItem};

#[cfg(any(feature = "http", feature = "ws"))]
#[derive(Debug, Clone, PartialEq, Eq, Hash, Deserialize, Serialize)]
#[serde(rename_all = "camelCase")]
/// Basic details about an user
pub struct UserBase {
	/// The ID of the user
	pub id: crate::id::User,
	/// The display name of the user
	pub name: String,
	/// The user's icon
	pub image_url: String,
}

#[cfg(feature = "http")]
#[derive(Debug, Clone, PartialEq, Eq, Hash, Deserialize, Serialize)]
#[serde(rename_all = "camelCase")]
/// Standard details about an user
pub struct UserDetails {
	#[serde(flatten)]
	/// The basic details of the user
	pub base: UserBase,
	/// The users rank
	pub rank: String,
	/// The users featured badge
	pub featured_badge: FeaturedItem,
	/// The users featured group
	pub featured_group: FeaturedItem,
	/// The users current avatar
	pub avatar: AssetBase,
}

#[cfg(feature = "http")]
#[derive(Clone, PartialEq, Eq, Hash, Deserialize, Serialize)]
#[serde(rename_all = "camelCase")]
/// Authentication success response
pub struct UserAuth {
	/// The username that the authentication is for
	pub username: String,
	/// The access key to authenticate future requests with
	pub access_key: String,
	/// The ID of the user that the authentication is for
	pub user_id: crate::id::User,
	/// The ID of the avatar that the user had selected at the time of the
	/// response
	pub current_avatar: crate::id::Asset,
	/// The ID of the home world that the user had selected at the time of the
	/// response
	pub current_home_world: crate::id::Asset,
	/// An URL to a video downloader executable
	pub video_url_resolver_executable: String,
	/// An URL to a hash file for the video downloader executable
	pub video_url_resolver_hashes: String,
	#[serde(default)]
	/// Users that were blocked by the user at the time of the response
	pub blocked_users: Vec<String>,
}

#[cfg(feature = "http")]
impl std::fmt::Debug for UserAuth {
	fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
		f.debug_struct("UserAuth")
			.field("username", &self.username)
			.field("access_key", &"*****")
			.field("user_id", &self.user_id)
			.field("current_avatar", &self.current_avatar)
			.field("current_home_world", &self.current_home_world)
			.field(
				"video_url_resolver_executable",
				&self.video_url_resolver_executable,
			)
			.field("video_url_resolver_hashes", &self.video_url_resolver_hashes)
			.field("blocked_users", &self.blocked_users)
			.finish()
	}
}

/// Details about a friend
#[cfg(feature = "http")]
pub type Friend = AssetBaseWithCategories<crate::id::User>;

#[cfg(feature = "http")]
#[serde_with::serde_as]
#[derive(Debug, Clone, PartialEq, Eq, Hash, Deserialize, Serialize)]
/// A list of friends
pub struct Friends(
	#[cfg_attr(
		not(feature = "debug"),
		serde_as(as = "serde_with::VecSkipError<_>")
	)]
	pub Vec<Friend>,
);

#[cfg(feature = "http")]
#[serde_with::serde_as]
#[derive(Debug, Clone, PartialEq, Eq, Hash, Deserialize, Serialize)]
/// A list of friend requests
pub struct FriendRequests(
	#[cfg_attr(
		not(feature = "debug"),
		serde_as(as = "serde_with::VecSkipError<_>")
	)]
	pub Vec<AssetBase>,
);

#[cfg(feature = "ws")]
#[derive(Debug, Clone, PartialEq, Eq, Hash, Deserialize, Serialize)]
#[serde(rename_all = "camelCase")]
/// A change event of an user's status
pub struct UserOnlineStatusChange {
	/// The ID of the user
	pub id: crate::id::User,
	/// If the user is now online or offline
	pub is_online: bool,
}

#[cfg(feature = "ws")]
#[serde_with::serde_as]
#[derive(Debug, Clone, PartialEq, Eq, Hash, Deserialize, Serialize)]
#[serde(rename_all = "camelCase")]
/// A list of user online status change events
pub struct OnlineUserStatusChanges(
	#[cfg_attr(
		not(feature = "debug"),
		serde_as(as = "serde_with::VecSkipError<_>")
	)]
	pub Vec<UserOnlineStatusChange>,
);