serenity 0.12.5

A Rust library for the Discord 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
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160

//! A set of builders used to make using methods on certain structs simpler to use.
//!
//! These are used when not all parameters are required, all parameters are optional, and/or sane
//! default values for required parameters can be applied by a builder.

// Option<Option<T>> is required for fields that are
// #[serde(skip_serializing_if = "Option::is_none")]
#![allow(clippy::option_option)]

#[cfg(feature = "http")]
use crate::http::CacheHttp;
#[cfg(feature = "http")]
use crate::internal::prelude::*;

/// Common trait for all HTTP request builders in this module.
#[cfg(feature = "http")]
#[async_trait::async_trait]
pub trait Builder {
    /// Additional data that's only required when sending a request off to the API.
    type Context<'ctx>;
    type Built;
    /// Serializes a builder's fields and sends the request off the API, returning the response.
    async fn execute(
        self,
        cache_http: impl CacheHttp,
        ctx: Self::Context<'_>,
    ) -> Result<Self::Built>;
}

#[cfg(feature = "http")]
pub(crate) fn check_overflow(len: usize, max: usize) -> StdResult<(), usize> {
    if len > max {
        Err(len - max)
    } else {
        Ok(())
    }
}

mod add_member;
mod bot_auth_parameters;
mod create_allowed_mentions;
mod create_attachment;
mod create_channel;
mod create_command;
mod create_command_permission;
mod create_components;
mod create_embed;
mod create_forum_post;
mod create_forum_tag;
mod create_interaction_response;
mod create_interaction_response_followup;
mod create_invite;
mod create_message;
pub mod create_poll;
mod create_scheduled_event;
mod create_soundboard;
mod create_stage_instance;
mod create_sticker;
mod create_thread;
mod create_webhook;
mod edit_automod_rule;
mod edit_channel;
mod edit_guild;
mod edit_guild_incident_actions;
mod edit_guild_welcome_screen;
mod edit_guild_widget;
mod edit_interaction_response;
mod edit_member;
mod edit_message;
mod edit_profile;
mod edit_role;
mod edit_scheduled_event;
mod edit_soundboard;
mod edit_stage_instance;
mod edit_sticker;
mod edit_thread;
mod edit_voice_state;
mod edit_webhook;
mod edit_webhook_message;
mod execute_webhook;
mod get_entitlements;
mod get_messages;

pub use add_member::*;
pub use bot_auth_parameters::*;
pub use create_allowed_mentions::*;
pub use create_attachment::*;
pub use create_channel::*;
pub use create_command::*;
pub use create_command_permission::*;
pub use create_components::*;
pub use create_embed::*;
pub use create_forum_post::*;
pub use create_forum_tag::*;
pub use create_interaction_response::*;
pub use create_interaction_response_followup::*;
pub use create_invite::*;
pub use create_message::*;
pub use create_poll::{CreatePoll, CreatePollAnswer};
pub use create_scheduled_event::*;
pub use create_soundboard::*;
pub use create_stage_instance::*;
pub use create_sticker::*;
pub use create_thread::*;
pub use create_webhook::*;
pub use edit_automod_rule::*;
pub use edit_channel::*;
pub use edit_guild::*;
pub use edit_guild_incident_actions::*;
pub use edit_guild_welcome_screen::*;
pub use edit_guild_widget::*;
pub use edit_interaction_response::*;
pub use edit_member::*;
pub use edit_message::*;
pub use edit_profile::*;
pub use edit_role::*;
pub use edit_scheduled_event::*;
pub use edit_soundboard::*;
pub use edit_stage_instance::*;
pub use edit_sticker::*;
pub use edit_thread::*;
pub use edit_voice_state::*;
pub use edit_webhook::*;
pub use edit_webhook_message::*;
pub use execute_webhook::*;
pub use get_entitlements::*;
pub use get_messages::*;

macro_rules! button_and_select_menu_convenience_methods {
    ($self:ident $(. $components_path:tt)+) => {
        /// Adds a clickable button to this message.
        ///
        /// Convenience method that wraps [`Self::components`]. Arranges buttons in action rows
        /// automatically.
        pub fn button(mut $self, button: super::CreateButton) -> Self {
            let rows = $self$(.$components_path)+.get_or_insert_with(Vec::new);
            let row_with_space_left = rows.last_mut().and_then(|row| match row {
                super::CreateActionRow::Buttons(buttons) if buttons.len() < 5 => Some(buttons),
                _ => None,
            });
            match row_with_space_left {
                Some(row) => row.push(button),
                None => rows.push(super::CreateActionRow::Buttons(vec![button])),
            }
            $self
        }

        /// Adds an interactive select menu to this message.
        ///
        /// Convenience method that wraps [`Self::components`].
        pub fn select_menu(mut $self, select_menu: super::CreateSelectMenu) -> Self {
            $self$(.$components_path)+
                .get_or_insert_with(Vec::new)
                .push(super::CreateActionRow::SelectMenu(select_menu));
            $self
        }
    };
}

use button_and_select_menu_convenience_methods;