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

//! Data about queries which can be used with your HTTP client of choice.
//!
//! An example implementation is provided with reqwest,
//! from `chilloutvr::api_client` if you enabled the `api_client` feature.

use serde::{Deserialize, Serialize};

mod categories;
pub use categories::*;
mod friends;
pub use friends::*;
mod instances;
pub use instances::*;
mod users;
pub use users::*;
mod searches;
pub use searches::*;
mod worlds;
pub use worlds::*;
mod invites;
pub use invites::*;

#[derive(Debug, Clone, PartialEq, Eq, Hash, Deserialize, Serialize)]
/// [`racal::Queryable`](racal::Queryable)'s `RequiredApiState`.
///
/// Even unauthenticated requests to CVR's HTTP API should take rate limits
/// into account, thus not using `()` for the API state.
pub struct NoAuthentication {}

impl racal::FromApiState<Self> for NoAuthentication {
	fn from_state(state: &Self) -> &Self { state }
}

impl racal::FromApiState<SavedLoginCredentials> for NoAuthentication {
	fn from_state(_: &SavedLoginCredentials) -> &Self { &Self {} }
}

impl racal::FromApiState<Self> for SavedLoginCredentials {
	fn from_state(state: &Self) -> &Self { state }
}

/// A WS message going from the client to the CVR server
#[cfg(feature = "ws")]
#[derive(
	Debug,
	Clone,
	PartialEq,
	Eq,
	Hash,
	Deserialize,
	Serialize,
	strum::Display,
	strum::AsRefStr,
	strum::VariantNames,
)]
#[non_exhaustive]
#[allow(missing_docs)]
pub enum RequestType {
	/// Should be sent as a keepalive to keep an account marked as online.
	///
	/// Can for example be sent every 30 seconds.
	SelfOnline = 0,
	FriendRequestSend = 5,
	FriendRequestAccept = 6,
	FriendRequestDecline = 7,
	UnFriend = 8,
	InviteSend = 10,
	InviteExpire = 11,
	RequestInvite = 15,
	RequestInviteAccept = 16,
	RequestInviteDecline = 17,
	BlockUser = 30,
	UnBlockUser = 31,
	GlobalMessage = 100,
	UserMessage = 101,
	SystemGlobalAnnouncement = 110,
	SystemUserAnnouncement = 111,
}

/// Data for a WS request
#[cfg(feature = "ws")]
pub trait Requestable {
	/// The type of the request
	fn request_type(&self) -> RequestType;
}

/// The WS API message base structure
#[cfg(feature = "ws")]
#[derive(Debug, Clone, PartialEq, Eq, Hash, Deserialize, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct RequestWrapper<T> {
	/// An enum that indicates the WS message's type
	pub request_type: RequestType,
	/// The actual data of the message
	pub data: T,
}

/// Mark the connected user account as being online
#[cfg(feature = "ws")]
#[derive(Debug, Clone, PartialEq, Eq, Hash, Deserialize, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct Online;

#[cfg(feature = "ws")]
impl Requestable for Online {
	fn request_type(&self) -> RequestType { RequestType::SelfOnline }
}