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

use serde::{Deserialize, Serialize};

#[cfg(feature = "ws")]
use crate::model::{UserBase, WorldDisplayDetails};

/// A request from the sender to be invited by the receiver
#[cfg(feature = "ws")]
#[derive(Debug, Clone, PartialEq, Eq, Hash, Deserialize, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct InviteRequest {
	/// The ID of the invite
	pub id: crate::id::Invite,
	/// The sender of the invite request
	pub sender: crate::model::UserBase,
	/// The receiver's ID
	pub receiver_id: crate::id::User,
}

/// An invite from someone to join their instance
#[cfg(feature = "ws")]
#[derive(Debug, Clone, PartialEq, Eq, Hash, Deserialize, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct Invite {
	/// The ID of the invite
	pub id: crate::id::Invite,
	/// The user that this invite is from
	pub user: UserBase,
	/// The world that this invite is to
	pub world: WorldDisplayDetails,
	/// The ID of the instance that this invite is to
	pub instance_id: crate::id::Instance,
	/// The receiving user's ID
	pub receiver_id: crate::id::User,
	/// The instance's name that this invite is to
	pub instance_name: String,
}

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

#[cfg(feature = "ws")]
#[serde_with::serde_as]
#[derive(Debug, Clone, PartialEq, Eq, Hash, Deserialize, Serialize)]
#[serde(rename_all = "camelCase")]
/// A list of invite requests
pub struct InviteRequests(
	#[cfg_attr(
		not(feature = "debug"),
		serde_as(as = "serde_with::VecSkipError<_>")
	)]
	pub Vec<InviteRequest>,
);