[−][src]Enum serenity::http::routing::Route
A representation of all routes registered within the library. These are safe
and memory-efficient representations of each path that functions exist for
in the http
module.
Variants
ChannelsId(u64)
Route for the /channels/:channel_id
path.
The data is the relevant ChannelId
.
ChannelsIdInvites(u64)
Route for the /channels/:channel_id/invites
path.
The data is the relevant ChannelId
.
ChannelsIdMessages(u64)
Route for the /channels/:channel_id/messages
path.
The data is the relevant ChannelId
.
ChannelsIdMessagesBulkDelete(u64)
Route for the /channels/:channel_id/messages/bulk-delete
path.
The data is the relevant ChannelId
.
ChannelsIdMessagesId(LightMethod, u64)
Route for the /channels/:channel_id/messages/:message_id
path.
The data is the relevant ChannelId
.
ChannelsIdMessagesIdAck(u64)
Route for the /channels/:channel_id/messages/:message_id/ack
path.
The data is the relevant ChannelId
.
ChannelsIdMessagesIdReactions(u64)
Route for the /channels/:channel_id/messages/:message_id/reactions
path.
The data is the relevant ChannelId
.
ChannelsIdMessagesIdReactionsUserIdType(u64)
Route for the
/channels/:channel_id/messages/:message_id/reactions/:reaction/@me
path.
The data is the relevant ChannelId
.
ChannelsIdPermissionsOverwriteId(u64)
Route for the /channels/:channel_id/permissions/:target_id
path.
The data is the relevant ChannelId
.
ChannelsIdPins(u64)
Route for the /channels/:channel_id/pins
path.
The data is the relevant ChannelId
.
ChannelsIdPinsMessageId(u64)
Route for the /channels/:channel_id/pins/:message_id
path.
The data is the relevant ChannelId
.
ChannelsIdTyping(u64)
Route for the /channels/:channel_id/typing
path.
The data is the relevant ChannelId
.
ChannelsIdWebhooks(u64)
Route for the /channels/:channel_id/webhooks
path.
The data is the relevant ChannelId
.
Gateway
Route for the /gateway
path.
GatewayBot
Route for the /gateway/bot
path.
Guilds
Route for the /guilds
path.
GuildsId(u64)
Route for the /guilds/:guild_id
path.
The data is the relevant GuildId
.
GuildsIdBans(u64)
Route for the /guilds/:guild_id/bans
path.
The data is the relevant GuildId
.
GuildsIdAuditLogs(u64)
Route for the /guilds/:guild_id/audit-logs
path.
The data is the relevant GuildId
.
GuildsIdBansUserId(u64)
Route for the /guilds/:guild_id/bans/:user_id
path.
The data is the relevant GuildId
.
GuildsIdChannels(u64)
Route for the /guilds/:guild_id/channels/:channel_id
path.
The data is the relevant GuildId
.
GuildsIdEmbed(u64)
Route for the /guilds/:guild_id/embed
path.
The data is the relevant GuildId
.
GuildsIdEmojis(u64)
Route for the /guilds/:guild_id/emojis
path.
The data is the relevant GuildId
.
GuildsIdEmojisId(u64)
Route for the /guilds/:guild_id/emojis/:emoji_id
path.
The data is the relevant GuildId
.
GuildsIdIntegrations(u64)
Route for the /guilds/:guild_id/integrations
path.
The data is the relevant GuildId
.
GuildsIdIntegrationsId(u64)
Route for the /guilds/:guild_id/integrations/:integration_id
path.
The data is the relevant GuildId
.
GuildsIdIntegrationsIdSync(u64)
Route for the /guilds/:guild_id/integrations/:integration_id/sync
path.
The data is the relevant GuildId
.
GuildsIdInvites(u64)
Route for the /guilds/:guild_id/invites
path.
The data is the relevant GuildId
.
GuildsIdMembers(u64)
Route for the /guilds/:guild_id/members
path.
The data is the relevant GuildId
.
GuildsIdMembersId(u64)
Route for the /guilds/:guild_id/members/:user_id
path.
The data is the relevant GuildId
.
GuildsIdMembersIdRolesId(u64)
Route for the /guilds/:guild_id/members/:user_id/roles/:role_id
path.
The data is the relevant GuildId
.
GuildsIdMembersMeNick(u64)
Route for the /guilds/:guild_id/members/@me/nick
path.
The data is the relevant GuildId
.
GuildsIdPrune(u64)
Route for the /guilds/:guild_id/prune
path.
The data is the relevant GuildId
.
GuildsIdRegions(u64)
Route for the /guilds/:guild_id/regions
path.
The data is the relevant GuildId
.
GuildsIdRoles(u64)
Route for the /guilds/:guild_id/roles
path.
The data is the relevant GuildId
.
GuildsIdRolesId(u64)
Route for the /guilds/:guild_id/roles/:role_id
path.
The data is the relevant GuildId
.
GuildsIdVanityUrl(u64)
Route for the /guilds/:guild_id/vanity-url
path.
The data is the relevant GuildId
.
GuildsIdWebhooks(u64)
Route for the /guilds/:guild_id/webhooks
path.
The data is the relevant GuildId
.
InvitesCode
Route for the /invites/:code
path.
UsersId
Route for the /users/:user_id
path.
UsersMe
Route for the /users/@me
path.
UsersMeChannels
Route for the /users/@me/channels
path.
UsersMeGuilds
Route for the /users/@me/guilds
path.
UsersMeGuildsId
Route for the /users/@me/guilds/:guild_id
path.
VoiceRegions
Route for the /voice/regions
path.
WebhooksId(u64)
Route for the /webhooks/:webhook_id
path.
None
Route where no ratelimit headers are in place (i.e. user account-only routes).
This is a special case, in that if the route is None
then pre- and
post-hooks are not executed.
Methods
impl Route
[src]
impl Route
pub fn channel(channel_id: u64) -> String
[src]
pub fn channel(channel_id: u64) -> String
pub fn channel_invites(channel_id: u64) -> String
[src]
pub fn channel_invites(channel_id: u64) -> String
pub fn channel_message(channel_id: u64, message_id: u64) -> String
[src]
pub fn channel_message(channel_id: u64, message_id: u64) -> String
pub fn channel_message_reaction<D, T>(
channel_id: u64,
message_id: u64,
user_id: D,
reaction_type: T
) -> String where
D: Display,
T: Display,
[src]
pub fn channel_message_reaction<D, T>(
channel_id: u64,
message_id: u64,
user_id: D,
reaction_type: T
) -> String where
D: Display,
T: Display,
pub fn channel_message_reactions(channel_id: u64, message_id: u64) -> String
[src]
pub fn channel_message_reactions(channel_id: u64, message_id: u64) -> String
pub fn channel_message_reactions_list(
channel_id: u64,
message_id: u64,
reaction: &str,
limit: u8,
after: Option<u64>
) -> String
[src]
pub fn channel_message_reactions_list(
channel_id: u64,
message_id: u64,
reaction: &str,
limit: u8,
after: Option<u64>
) -> String
pub fn channel_messages(channel_id: u64, query: Option<&str>) -> String
[src]
pub fn channel_messages(channel_id: u64, query: Option<&str>) -> String
pub fn channel_messages_bulk_delete(channel_id: u64) -> String
[src]
pub fn channel_messages_bulk_delete(channel_id: u64) -> String
pub fn channel_permission(channel_id: u64, target_id: u64) -> String
[src]
pub fn channel_permission(channel_id: u64, target_id: u64) -> String
pub fn channel_pin(channel_id: u64, message_id: u64) -> String
[src]
pub fn channel_pin(channel_id: u64, message_id: u64) -> String
pub fn channel_pins(channel_id: u64) -> String
[src]
pub fn channel_pins(channel_id: u64) -> String
pub fn channel_typing(channel_id: u64) -> String
[src]
pub fn channel_typing(channel_id: u64) -> String
pub fn channel_webhooks(channel_id: u64) -> String
[src]
pub fn channel_webhooks(channel_id: u64) -> String
pub fn gateway() -> &'static str
[src]
pub fn gateway() -> &'static str
pub fn gateway_bot() -> &'static str
[src]
pub fn gateway_bot() -> &'static str
pub fn group_recipient(group_id: u64, user_id: u64) -> String
[src]
pub fn group_recipient(group_id: u64, user_id: u64) -> String
pub fn guild(guild_id: u64) -> String
[src]
pub fn guild(guild_id: u64) -> String
pub fn guild_audit_logs(
guild_id: u64,
action_type: Option<u8>,
user_id: Option<u64>,
before: Option<u64>,
limit: Option<u8>
) -> String
[src]
pub fn guild_audit_logs(
guild_id: u64,
action_type: Option<u8>,
user_id: Option<u64>,
before: Option<u64>,
limit: Option<u8>
) -> String
pub fn guild_ban(guild_id: u64, user_id: u64) -> String
[src]
pub fn guild_ban(guild_id: u64, user_id: u64) -> String
pub fn guild_ban_optioned(
guild_id: u64,
user_id: u64,
delete_message_days: u8,
reason: &str
) -> String
[src]
pub fn guild_ban_optioned(
guild_id: u64,
user_id: u64,
delete_message_days: u8,
reason: &str
) -> String
pub fn guild_bans(guild_id: u64) -> String
[src]
pub fn guild_bans(guild_id: u64) -> String
pub fn guild_channels(guild_id: u64) -> String
[src]
pub fn guild_channels(guild_id: u64) -> String
pub fn guild_embed(guild_id: u64) -> String
[src]
pub fn guild_embed(guild_id: u64) -> String
pub fn guild_emojis(guild_id: u64) -> String
[src]
pub fn guild_emojis(guild_id: u64) -> String
pub fn guild_emoji(guild_id: u64, emoji_id: u64) -> String
[src]
pub fn guild_emoji(guild_id: u64, emoji_id: u64) -> String
pub fn guild_integration(guild_id: u64, integration_id: u64) -> String
[src]
pub fn guild_integration(guild_id: u64, integration_id: u64) -> String
pub fn guild_integration_sync(guild_id: u64, integration_id: u64) -> String
[src]
pub fn guild_integration_sync(guild_id: u64, integration_id: u64) -> String
pub fn guild_integrations(guild_id: u64) -> String
[src]
pub fn guild_integrations(guild_id: u64) -> String
pub fn guild_invites(guild_id: u64) -> String
[src]
pub fn guild_invites(guild_id: u64) -> String
pub fn guild_member(guild_id: u64, user_id: u64) -> String
[src]
pub fn guild_member(guild_id: u64, user_id: u64) -> String
pub fn guild_member_role(guild_id: u64, user_id: u64, role_id: u64) -> String
[src]
pub fn guild_member_role(guild_id: u64, user_id: u64, role_id: u64) -> String
pub fn guild_members(guild_id: u64) -> String
[src]
pub fn guild_members(guild_id: u64) -> String
pub fn guild_members_optioned(
guild_id: u64,
after: Option<u64>,
limit: Option<u64>
) -> String
[src]
pub fn guild_members_optioned(
guild_id: u64,
after: Option<u64>,
limit: Option<u64>
) -> String
pub fn guild_nickname(guild_id: u64) -> String
[src]
pub fn guild_nickname(guild_id: u64) -> String
pub fn guild_prune(guild_id: u64, days: u64) -> String
[src]
pub fn guild_prune(guild_id: u64, days: u64) -> String
pub fn guild_regions(guild_id: u64) -> String
[src]
pub fn guild_regions(guild_id: u64) -> String
pub fn guild_role(guild_id: u64, role_id: u64) -> String
[src]
pub fn guild_role(guild_id: u64, role_id: u64) -> String
pub fn guild_roles(guild_id: u64) -> String
[src]
pub fn guild_roles(guild_id: u64) -> String
pub fn guild_vanity_url(guild_id: u64) -> String
[src]
pub fn guild_vanity_url(guild_id: u64) -> String
pub fn guild_webhooks(guild_id: u64) -> String
[src]
pub fn guild_webhooks(guild_id: u64) -> String
pub fn guilds() -> &'static str
[src]
pub fn guilds() -> &'static str
pub fn invite(code: &str) -> String
[src]
pub fn invite(code: &str) -> String
pub fn invite_optioned(code: &str, stats: bool) -> String
[src]
pub fn invite_optioned(code: &str, stats: bool) -> String
pub fn oauth2_application_current() -> &'static str
[src]
pub fn oauth2_application_current() -> &'static str
pub fn private_channel() -> &'static str
[src]
pub fn private_channel() -> &'static str
pub fn status_incidents_unresolved() -> &'static str
[src]
pub fn status_incidents_unresolved() -> &'static str
pub fn status_maintenances_active() -> &'static str
[src]
pub fn status_maintenances_active() -> &'static str
pub fn status_maintenances_upcoming() -> &'static str
[src]
pub fn status_maintenances_upcoming() -> &'static str
pub fn user<D: Display>(target: D) -> String
[src]
pub fn user<D: Display>(target: D) -> String
pub fn user_dm_channels<D: Display>(target: D) -> String
[src]
pub fn user_dm_channels<D: Display>(target: D) -> String
pub fn user_guild<D: Display>(target: D, guild_id: u64) -> String
[src]
pub fn user_guild<D: Display>(target: D, guild_id: u64) -> String
pub fn user_guilds<D: Display>(target: D) -> String
[src]
pub fn user_guilds<D: Display>(target: D) -> String
pub fn user_guilds_optioned<D: Display>(
target: D,
after: Option<u64>,
before: Option<u64>,
limit: u64
) -> String
[src]
pub fn user_guilds_optioned<D: Display>(
target: D,
after: Option<u64>,
before: Option<u64>,
limit: u64
) -> String
pub fn voice_regions() -> &'static str
[src]
pub fn voice_regions() -> &'static str
pub fn webhook(webhook_id: u64) -> String
[src]
pub fn webhook(webhook_id: u64) -> String
pub fn webhook_with_token<D>(webhook_id: u64, token: D) -> String where
D: Display,
[src]
pub fn webhook_with_token<D>(webhook_id: u64, token: D) -> String where
D: Display,
pub fn webhook_with_token_optioned<D>(
webhook_id: u64,
token: D,
wait: bool
) -> String where
D: Display,
[src]
pub fn webhook_with_token_optioned<D>(
webhook_id: u64,
token: D,
wait: bool
) -> String where
D: Display,
Trait Implementations
impl PartialEq<Route> for Route
[src]
impl PartialEq<Route> for Route
fn eq(&self, other: &Route) -> bool
[src]
fn eq(&self, other: &Route) -> bool
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, other: &Route) -> bool
[src]
fn ne(&self, other: &Route) -> bool
This method tests for !=
.
impl Clone for Route
[src]
impl Clone for Route
fn clone(&self) -> Route
[src]
fn clone(&self) -> Route
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
impl Copy for Route
[src]
impl Copy for Route
impl Eq for Route
[src]
impl Eq for Route
impl Debug for Route
[src]
impl Debug for Route
fn fmt(&self, f: &mut Formatter) -> Result
[src]
fn fmt(&self, f: &mut Formatter) -> Result
Formats the value using the given formatter. Read more
impl Hash for Route
[src]
impl Hash for Route
Auto Trait Implementations
Blanket Implementations
impl<T, U> Into for T where
U: From<T>,
[src]
impl<T, U> Into for T where
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
impl<T> ToOwned for T where
T: Clone,
type Owned = T
fn to_owned(&self) -> T
[src]
fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning. Read more
fn clone_into(&self, target: &mut T)
[src]
fn clone_into(&self, target: &mut T)
🔬 This is a nightly-only experimental API. (toowned_clone_into
)
recently added
Uses borrowed data to replace owned data, usually by cloning. Read more
impl<T> From for T
[src]
impl<T> From for T
impl<T, U> TryFrom for T where
T: From<U>,
[src]
impl<T, U> TryFrom for T where
T: From<U>,
type Error = !
try_from
)The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
try_from
)Performs the conversion.
impl<T> Borrow for T where
T: ?Sized,
[src]
impl<T> Borrow for T where
T: ?Sized,
impl<T> BorrowMut for T where
T: ?Sized,
[src]
impl<T> BorrowMut for T where
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<T, U> TryInto for T where
U: TryFrom<T>,
[src]
impl<T, U> TryInto for T where
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
try_from
)The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
try_from
)Performs the conversion.
impl<T> Any for T where
T: 'static + ?Sized,
[src]
impl<T> Any for T where
T: 'static + ?Sized,
fn get_type_id(&self) -> TypeId
[src]
fn get_type_id(&self) -> TypeId
🔬 This is a nightly-only experimental API. (get_type_id
)
this method will likely be replaced by an associated static
Gets the TypeId
of self
. Read more
impl<T> Erased for T
impl<T> Erased for T
impl<T> Typeable for T where
T: Any,
impl<T> Typeable for T where
T: Any,
impl<T> DebugAny for T where
T: Any + Debug,
[src]
impl<T> DebugAny for T where
T: Any + Debug,
impl<T> CloneAny for T where
T: Clone + Any,
[src]
impl<T> CloneAny for T where
T: Clone + Any,
fn clone_any(&self) -> Box<dyn CloneAny + 'static>
[src]
fn clone_any(&self) -> Box<dyn CloneAny + 'static>
fn clone_any_send(&self) -> Box<dyn CloneAny + 'static + Send> where
T: Send,
[src]
fn clone_any_send(&self) -> Box<dyn CloneAny + 'static + Send> where
T: Send,
fn clone_any_sync(&self) -> Box<dyn CloneAny + 'static + Sync> where
T: Sync,
[src]
fn clone_any_sync(&self) -> Box<dyn CloneAny + 'static + Sync> where
T: Sync,
fn clone_any_send_sync(&self) -> Box<dyn CloneAny + 'static + Sync + Send> where
T: Send + Sync,
[src]
fn clone_any_send_sync(&self) -> Box<dyn CloneAny + 'static + Sync + Send> where
T: Send + Sync,
impl<T> UnsafeAny for T where
T: Any,
impl<T> UnsafeAny for T where
T: Any,