essence 0.3.3

Essential models and database logic for the Adapt chat platform.
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

use crate::{
    models::{ChannelType, PermissionOverwrite},
    Maybe,
};
use serde::Deserialize;
#[cfg(feature = "client")]
use serde::Serialize;
#[cfg(feature = "openapi")]
use utoipa::ToSchema;

/// The type and other information sent to create a new guild channel.
#[derive(Clone, Debug, Deserialize)]
#[cfg_attr(feature = "client", derive(Serialize))]
#[cfg_attr(feature = "openapi", derive(ToSchema))]
#[serde(tag = "type")]
pub enum CreateGuildChannelInfo {
    /// A text channel.
    Text {
        /// The topic of the text channel, if any.
        topic: Option<String>,
        /// The icon of the channel represented as a
        /// [Data URI scheme](https://en.wikipedia.org/wiki/Data_URI_scheme), if any.
        icon: Option<String>,
    },
    /// An announcement channel.
    Announcement {
        /// The topic of the text channel, if any.
        topic: Option<String>,
        /// The icon of the channel represented as a
        /// [Data URI scheme](https://en.wikipedia.org/wiki/Data_URI_scheme), if any.
        icon: Option<String>,
    },
    /// A voice channel.
    Voice {
        /// The user limit of the channel. This should be a value between `0` and `500`. A value
        /// of `0` is the default and indicates the absence of a user limit.
        #[serde(default)]
        user_limit: u16,
        /// The URL of the icon of the channel, if any.
        icon: Option<String>,
    },
    /// A category channel.
    Category,
}

impl CreateGuildChannelInfo {
    /// Returns the [`ChannelType`] of the requested channel.
    #[inline]
    #[must_use]
    pub const fn channel_type(&self) -> ChannelType {
        match self {
            Self::Text { .. } => ChannelType::Text,
            Self::Announcement { .. } => ChannelType::Announcement,
            Self::Voice { .. } => ChannelType::Voice,
            Self::Category => ChannelType::Category,
        }
    }
}

/// The request body sent to create a new channel in a guild.
#[derive(Clone, Debug, Deserialize)]
#[cfg_attr(feature = "client", derive(Serialize))]
#[cfg_attr(feature = "openapi", derive(ToSchema))]
pub struct CreateGuildChannelPayload {
    /// The name of the text channel.
    pub name: String,
    /// The type of the channel and information specific to it.
    #[serde(flatten)]
    pub info: CreateGuildChannelInfo,
    /// The icon of the text channel, if any.
    pub icon: Option<String>,
    /// The ID of the category to create the channel in, if any.
    pub parent_id: Option<u64>,
    /// A list of permission overwrites to apply to the channel, if any.
    pub overwrites: Option<Vec<PermissionOverwrite>>,
}

/// The request body sent to modify a channel.
#[derive(Clone, Debug, Deserialize)]
#[cfg_attr(feature = "client", derive(Serialize))]
#[cfg_attr(feature = "openapi", derive(ToSchema))]
pub struct EditChannelPayload {
    /// The new name of the channel. If left blank, the name will not be changed. Takes effect for
    /// all channels except for user DMs.
    pub name: Option<String>,
    /// The new topic or description of the channel. Explicitly setting this to `None` will clear
    /// the topic. Only takes effect for text-based channels in guilds, or group chats.
    #[serde(default)]
    #[cfg_attr(feature = "client", serde(skip_serializing_if = "Maybe::is_absent"))]
    #[cfg_attr(feature = "openapi", schema(nullable, value_type = Option<String>))]
    pub topic: Maybe<String>,
    /// The new icon of the channel. Explicitly setting this to `None` will clear the icon.
    /// Takes effect for all channels except for user DMs.
    ///
    /// This should be a [Data URI scheme](https://en.wikipedia.org/wiki/Data_URI_scheme).
    #[serde(default)]
    #[cfg_attr(feature = "client", serde(skip_serializing_if = "Maybe::is_absent"))]
    #[cfg_attr(feature = "openapi", schema(nullable, value_type = Option<String>, format = "byte"))]
    pub icon: Maybe<String>,
    /// The new user limit of the voice channel. Explicitly setting this to `0` will remove the
    /// current limit, if there is any. Only takes effect for guild voice channels.
    pub user_limit: Option<u16>,
}

/// The payload used per channel to specify its new position data.
#[derive(Clone, Debug, Deserialize)]
#[cfg_attr(feature = "client", derive(Serialize))]
#[cfg_attr(feature = "openapi", derive(ToSchema))]
pub struct EditChannelPositionPayload {
    /// The ID of the channel to modify.
    pub id: u64,
    /// The new position of the channel.
    pub position: u16,
    /// The new scope of the channel. If left blank, the scope will not be changed. If set to
    /// `Null`, the channel will be moved to the root of the channel list.
    #[serde(default)]
    #[cfg_attr(feature = "client", serde(skip_serializing_if = "Maybe::is_absent"))]
    #[cfg_attr(feature = "openapi", schema(nullable, value_type = Option<u64>))]
    pub scope: Maybe<u64>,
}

/// The request body sent to modify channel positions.
#[derive(Clone, Debug, Deserialize)]
#[cfg_attr(feature = "client", derive(Serialize))]
#[cfg_attr(feature = "openapi", derive(ToSchema))]
#[serde(transparent)]
pub struct EditChannelPositionsPayload {
    /// A list of channel positions to modify.
    pub positions: Vec<EditChannelPositionPayload>,
}