revolt_models/v0/
server_members.rs

1use std::collections::HashMap;
2
3use super::{File, Role, User};
4
5use iso8601_timestamp::Timestamp;
6use once_cell::sync::Lazy;
7use regex::Regex;
8
9#[cfg(feature = "validator")]
10use validator::Validate;
11
12#[cfg(feature = "rocket")]
13use rocket::FromForm;
14
15/// Regex for valid role colours
16///
17/// Allows the use of named colours, rgb(a), variables and all gradients.
18///
19/// Flags:
20/// - Case-insensitive (`i`)
21///
22/// Source:
23/// ```regex
24/// VALUE = [a-z ]+|var\(--[a-z\d-]+\)|rgba?\([\d, ]+\)|#[a-f0-9]+
25/// ADDITIONAL_VALUE = \d+deg
26/// STOP = ([ ]+(\d{1,3}%|0))?
27///
28/// ^(?:VALUE|(repeating-)?(linear|conic|radial)-gradient\((VALUE|ADDITIONAL_VALUE)STOP(,[ ]*(VALUE)STOP)+\))$
29/// ```
30pub static RE_COLOUR: Lazy<Regex> = Lazy::new(|| {
31    Regex::new(r"(?i)^(?:[a-z ]+|var\(--[a-z\d-]+\)|rgba?\([\d, ]+\)|#[a-f0-9]+|(repeating-)?(linear|conic|radial)-gradient\(([a-z ]+|var\(--[a-z\d-]+\)|rgba?\([\d, ]+\)|#[a-f0-9]+|\d+deg)([ ]+(\d{1,3}%|0))?(,[ ]*([a-z ]+|var\(--[a-z\d-]+\)|rgba?\([\d, ]+\)|#[a-f0-9]+)([ ]+(\d{1,3}%|0))?)+\))$").unwrap()
32});
33
34fn default_true() -> bool {
35    true
36}
37
38fn is_true(x: &bool) -> bool {
39    *x
40}
41
42auto_derived_partial!(
43    /// Server Member
44    pub struct Member {
45        /// Unique member id
46        #[cfg_attr(feature = "serde", serde(rename = "_id"))]
47        pub id: MemberCompositeKey,
48
49        /// Time at which this user joined the server
50        pub joined_at: Timestamp,
51
52        /// Member's nickname
53        #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
54        pub nickname: Option<String>,
55        /// Avatar attachment
56        #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
57        pub avatar: Option<File>,
58
59        /// Member's roles
60        #[cfg_attr(
61            feature = "serde",
62            serde(skip_serializing_if = "Vec::is_empty", default)
63        )]
64        pub roles: Vec<String>,
65        /// Timestamp this member is timed out until
66        #[cfg_attr(feature = "serde", serde(skip_serializing_if = "Option::is_none"))]
67        pub timeout: Option<Timestamp>,
68
69        /// Whether the member is server-wide voice muted
70        #[serde(skip_serializing_if = "is_true", default = "default_true")]
71        pub can_publish: bool,
72        /// Whether the member is server-wide voice deafened
73        #[serde(skip_serializing_if = "is_true", default = "default_true")]
74        pub can_receive: bool,
75    },
76    "PartialMember"
77);
78
79auto_derived!(
80    /// Composite primary key consisting of server and user id
81    #[derive(Hash, Default)]
82    pub struct MemberCompositeKey {
83        /// Server Id
84        pub server: String,
85        /// User Id
86        pub user: String,
87    }
88
89    /// Optional fields on server member object
90    pub enum FieldsMember {
91        Nickname,
92        Avatar,
93        Roles,
94        Timeout,
95        CanReceive,
96        CanPublish,
97        JoinedAt,
98        VoiceChannel,
99    }
100
101    /// Member removal intention
102    pub enum RemovalIntention {
103        Leave,
104        Kick,
105        Ban,
106    }
107
108    /// Member response
109    #[serde(untagged)]
110    pub enum MemberResponse {
111        Member(Member),
112        MemberWithRoles {
113            member: Member,
114            roles: HashMap<String, Role>,
115        },
116    }
117
118    /// Options for fetching all members
119    #[cfg_attr(feature = "rocket", derive(FromForm))]
120    pub struct OptionsFetchAllMembers {
121        /// Whether to exclude offline users
122        pub exclude_offline: Option<bool>,
123    }
124
125    /// Response with all members
126    pub struct AllMemberResponse {
127        /// List of members
128        pub members: Vec<Member>,
129        /// List of users
130        pub users: Vec<User>,
131    }
132
133    /// New member information
134    #[cfg_attr(feature = "validator", derive(Validate))]
135    pub struct DataMemberEdit {
136        /// Member nickname
137        #[cfg_attr(feature = "validator", validate(length(min = 1, max = 32)))]
138        pub nickname: Option<String>,
139        /// Attachment Id to set for avatar
140        pub avatar: Option<String>,
141        /// Array of role ids
142        pub roles: Option<Vec<String>>,
143        /// Timestamp this member is timed out until
144        pub timeout: Option<Timestamp>,
145        /// server-wide voice muted
146        pub can_publish: Option<bool>,
147        /// server-wide voice deafened
148        pub can_receive: Option<bool>,
149        /// voice channel to move to if already in a voice channel
150        pub voice_channel: Option<String>,
151        /// Fields to remove from channel object
152        #[cfg_attr(feature = "serde", serde(default))]
153        pub remove: Vec<FieldsMember>,
154    }
155);
revolt_models/v0/server_members.rs

revolt_models/v0/
server_members.rs
