discord-ferris 0.0.2

discord-ferris is a Discord API Rust library under development 🦀
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

use crate::models::rest::common::Locale;
use serde::{Deserialize, Serialize};
use std::collections::HashMap;

bitflags::bitflags! {
    /// Permission bit flags, based on Discord's documentation.
    /// Each permission is represented as a bit in a `u64`.
    #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Serialize, Deserialize)]
    #[serde(transparent)]
    pub struct PermissionFlagsBits: u64 {
        const CREATE_INSTANT_INVITE           = 1 << 0;
        const KICK_MEMBERS                    = 1 << 1;
        const BAN_MEMBERS                     = 1 << 2;
        const ADMINISTRATOR                   = 1 << 3;
        const MANAGE_CHANNELS                 = 1 << 4;
        const MANAGE_GUILD                    = 1 << 5;
        const ADD_REACTIONS                   = 1 << 6;
        const VIEW_AUDIT_LOG                  = 1 << 7;
        const PRIORITY_SPEAKER                = 1 << 8;
        const STREAM                          = 1 << 9;
        const VIEW_CHANNEL                    = 1 << 10;
        const SEND_MESSAGES                   = 1 << 11;
        const SEND_TTS_MESSAGES               = 1 << 12;
        const MANAGE_MESSAGES                 = 1 << 13;
        const EMBED_LINKS                     = 1 << 14;
        const ATTACH_FILES                    = 1 << 15;
        const READ_MESSAGE_HISTORY            = 1 << 16;
        const MENTION_EVERYONE                = 1 << 17;
        const USE_EXTERNAL_EMOJIS             = 1 << 18;
        const VIEW_GUILD_INSIGHTS             = 1 << 19;
        const CONNECT                         = 1 << 20;
        const SPEAK                           = 1 << 21;
        const MUTE_MEMBERS                    = 1 << 22;
        const DEAFEN_MEMBERS                  = 1 << 23;
        const MOVE_MEMBERS                    = 1 << 24;
        const USE_VAD                         = 1 << 25;
        const CHANGE_NICKNAME                 = 1 << 26;
        const MANAGE_NICKNAMES                = 1 << 27;
        const MANAGE_ROLES                    = 1 << 28;
        const MANAGE_WEBHOOKS                 = 1 << 29;
        // @deprecated
        // const MANAGE_EMOJIS_AND_STICKERS      = 1 << 30;
        const MANAGE_GUILD_EXPRESSIONS        = 1 << 30;
        const USE_APPLICATION_COMMANDS        = 1 << 31;
        const REQUEST_TO_SPEAK                = 1 << 32;
        const MANAGE_EVENTS                   = 1 << 33;
        const MANAGE_THREADS                  = 1 << 34;
        const CREATE_PUBLIC_THREADS           = 1 << 35;
        const CREATE_PRIVATE_THREADS          = 1 << 36;
        const USE_EXTERNAL_STICKERS           = 1 << 37;
        const SEND_MESSAGES_IN_THREADS        = 1 << 38;
        const USE_EMBEDDED_ACTIVITIES         = 1 << 39;
        const MODERATE_MEMBERS                = 1 << 40;
        const VIEW_CREATOR_MONETIZATION_ANALYTICS = 1 << 41;
        const USE_SOUNDBOARD                  = 1 << 42;
        const CREATE_GUILD_EXPRESSIONS        = 1 << 43;
        const CREATE_EVENTS                   = 1 << 44;
        const USE_EXTERNAL_SOUNDS             = 1 << 45;
        const SEND_VOICE_MESSAGES             = 1 << 46;
        const SEND_POLLS                      = 1 << 49;
        const USE_EXTERNAL_APPS               = 1 << 50;
    }
}

pub type LocalizationMap = HashMap<Locale, Option<String>>;

/// Represents a REST API error from Discord.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct RESTError {
    pub code: i32,
    pub message: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub errors: Option<RESTErrorData>,
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct RESTErrorFieldInformation {
    pub code: String,
    pub message: String,
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct RESTErrorGroupWrapper {
    #[serde(rename = "_errors")]
    pub errors: Vec<RESTErrorData>,
}

/// The `RESTErrorData` type can be a string, a field info object,
/// a group wrapper, or a nested map of error data.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(untagged)]
pub enum RESTErrorData {
    FieldInfo(RESTErrorFieldInformation),
    GroupWrapper(RESTErrorGroupWrapper),
    String(String),
    Map(HashMap<String, RESTErrorData>),
}

/// Represents Discord's rate limit response.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct RESTRateLimit {
    /// Optional error code for certain limits.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub code: Option<i32>,
    /// Whether this is a global rate limit.
    pub global: bool,
    /// Message explaining the rate limit.
    pub message: String,
    /// Seconds to wait before retrying.
    pub retry_after: f64,
}