Enum serenity::http::routing::Route

#[non_exhaustive]
pub enum Route {
    ChannelsId(u64),
    ChannelsIdInvites(u64),
    ChannelsIdMessages(u64),
    ChannelsIdMessagesBulkDelete(u64),
    ChannelsIdMessagesId(LightMethod, u64),
    ChannelsIdMessagesIdAck(u64),
    ChannelsIdMessagesIdReactions(u64),
    ChannelsIdMessagesIdReactionsUserIdType(u64),
    ChannelsIdPermissionsOverwriteId(u64),
    ChannelsIdPins(u64),
    ChannelsIdPinsMessageId(u64),
    ChannelsIdCrosspostsMessageId(u64),
    ChannelsIdTyping(u64),
    ChannelsIdWebhooks(u64),
    ChannelsIdMessagesIdThreads(u64),
    ChannelsIdThreads(u64),
    ChannelsIdThreadMembersMe(u64),
    ChannelsIdThreadMembersUserId(u64),
    ChannelsIdThreadMembers(u64),
    ChannelsIdActiveThreads(u64),
    ChannelsIdArchivedPublicThreads(u64),
    ChannelsIdArchivedPrivateThreads(u64),
    ChannelsIdMeJoindedArchivedPrivateThreads(u64),
    Gateway,
    GatewayBot,
    Guilds,
    GuildsId(u64),
    GuildsIdBans(u64),
    GuildsIdAuditLogs(u64),
    GuildsIdBansUserId(u64),
    GuildsIdChannels(u64),
    GuildsIdWidget(u64),
    GuildsIdPreview(u64),
    GuildsIdEmojis(u64),
    GuildsIdEmojisId(u64),
    GuildsIdIntegrations(u64),
    GuildsIdIntegrationsId(u64),
    GuildsIdIntegrationsIdSync(u64),
    GuildsIdInvites(u64),
    GuildsIdMembers(u64),
    GuildsIdMembersId(u64),
    GuildsIdMembersIdRolesId(u64),
    GuildsIdMembersMe(u64),
    GuildsIdMembersMeNick(u64),
    GuildsIdMembersSearch(u64),
    GuildsIdPrune(u64),
    GuildsIdRegions(u64),
    GuildsIdRoles(u64),
    GuildsIdRolesId(u64),
    GuildsIdVanityUrl(u64),
    GuildsIdVoiceStates(u64),
    GuildsIdVoiceStatesMe(u64),
    GuildsIdWebhooks(u64),
    GuildsIdWelcomeScreen(u64),
    InvitesCode,
    UsersId,
    UsersMe,
    UsersMeChannels,
    UsersMeConnections,
    UsersMeGuilds,
    UsersMeGuildsId,
    VoiceRegions,
    WebhooksId(u64),
    WebhooksIdMessagesId(u64),
    WebhooksApplicationId(u64),
    InteractionsId(u64),
    ApplicationsIdCommands(u64),
    ApplicationsIdCommandsId(u64),
    ApplicationsIdGuildsIdCommands(u64),
    ApplicationsIdGuildsIdCommandsPermissions(u64),
    ApplicationsIdGuildsIdCommandIdPermissions(u64),
    ApplicationsIdGuildsIdCommandsId(u64),
    StageInstances,
    StageInstancesChannelId(u64),
    None,
}

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 (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

ChannelsId

Route for the /channels/:channel_id path.

The data is the relevant ChannelId.

Tuple Fields of ChannelsId

0: u64

ChannelsIdInvites

Route for the /channels/:channel_id/invites path.

The data is the relevant ChannelId.

Tuple Fields of ChannelsIdInvites

0: u64

ChannelsIdMessages

Route for the /channels/:channel_id/messages path.

The data is the relevant ChannelId.

Tuple Fields of ChannelsIdMessages

0: u64

ChannelsIdMessagesBulkDelete

Route for the /channels/:channel_id/messages/bulk-delete path.

The data is the relevant ChannelId.

Tuple Fields of ChannelsIdMessagesBulkDelete

0: u64

ChannelsIdMessagesId

Route for the /channels/:channel_id/messages/:message_id path.

The data is the relevant ChannelId.

Tuple Fields of ChannelsIdMessagesId

0: LightMethod1: u64

ChannelsIdMessagesIdAck

Route for the /channels/:channel_id/messages/:message_id/ack path.

The data is the relevant ChannelId.

Tuple Fields of ChannelsIdMessagesIdAck

0: u64

ChannelsIdMessagesIdReactions

Route for the /channels/:channel_id/messages/:message_id/reactions path.

The data is the relevant ChannelId.

Tuple Fields of ChannelsIdMessagesIdReactions

0: u64

ChannelsIdMessagesIdReactionsUserIdType

Route for the /channels/:channel_id/messages/:message_id/reactions/:reaction/@me path.

The data is the relevant ChannelId.

Tuple Fields of ChannelsIdMessagesIdReactionsUserIdType

0: u64

ChannelsIdPermissionsOverwriteId

Route for the /channels/:channel_id/permissions/:target_id path.

The data is the relevant ChannelId.

Tuple Fields of ChannelsIdPermissionsOverwriteId

0: u64

ChannelsIdPins

Route for the /channels/:channel_id/pins path.

The data is the relevant ChannelId.

Tuple Fields of ChannelsIdPins

0: u64

ChannelsIdPinsMessageId

Route for the /channels/:channel_id/pins/:message_id path.

The data is the relevant ChannelId.

Tuple Fields of ChannelsIdPinsMessageId

0: u64

ChannelsIdCrosspostsMessageId

Route for the /channels/:channel_id/message/:message_id/crosspost path.

The data is the relevant ChannelId.

Tuple Fields of ChannelsIdCrosspostsMessageId

0: u64

ChannelsIdTyping

Route for the /channels/:channel_id/typing path.

The data is the relevant ChannelId.

Tuple Fields of ChannelsIdTyping

0: u64

ChannelsIdWebhooks

Route for the /channels/:channel_id/webhooks path.

The data is the relevant ChannelId.

Tuple Fields of ChannelsIdWebhooks

0: u64

ChannelsIdMessagesIdThreads

Route for the /channels/:channel_id/messages/:message_id/threads path.

The data is the relevant ChannelId.

Tuple Fields of ChannelsIdMessagesIdThreads

0: u64

ChannelsIdThreads

Route for the /channels/:channel_id/threads path.

The data is the relevant ChannelId.

Tuple Fields of ChannelsIdThreads

0: u64

ChannelsIdThreadMembersMe

Route for the /channels/:channel_id/thread-members/@me path.

The data is the relevant ChannelId.

Tuple Fields of ChannelsIdThreadMembersMe

0: u64

ChannelsIdThreadMembersUserId

Route for the /channels/:channel_id/thread-members/:user_id path.

The data is the relevant ChannelId.

Tuple Fields of ChannelsIdThreadMembersUserId

0: u64

ChannelsIdThreadMembers

Route for the /channels/channel_id/thread-members path.

The data is the relevant ChannelId.

Tuple Fields of ChannelsIdThreadMembers

0: u64

ChannelsIdActiveThreads

Route for the /channels/:channel_id/threads/active path.

The data is the relevant ChannelId.

Tuple Fields of ChannelsIdActiveThreads

0: u64

ChannelsIdArchivedPublicThreads

Route for the /channels/:channel_id/threads/archived/public path.

The data is the relevant ChannelId.

Tuple Fields of ChannelsIdArchivedPublicThreads

0: u64

ChannelsIdArchivedPrivateThreads

Route for the /channels/:channel_id/threads/archived/private path.

The data is the relevant ChannelId.

Tuple Fields of ChannelsIdArchivedPrivateThreads

0: u64

ChannelsIdMeJoindedArchivedPrivateThreads

Route for the /channels/:channel_id/users/@me/threads/archived/private path.

The data is the relevant ChannelId.

Tuple Fields of ChannelsIdMeJoindedArchivedPrivateThreads

0: u64

Gateway

Route for the /gateway path.

GatewayBot

Route for the /gateway/bot path.

Guilds

Route for the /guilds path.

GuildsId

Route for the /guilds/:guild_id path.

The data is the relevant GuildId.

Tuple Fields of GuildsId

0: u64

GuildsIdBans

Route for the /guilds/:guild_id/bans path.

The data is the relevant GuildId.

Tuple Fields of GuildsIdBans

0: u64

GuildsIdAuditLogs

Route for the /guilds/:guild_id/audit-logs path. The data is the relevant GuildId.

Tuple Fields of GuildsIdAuditLogs

0: u64

GuildsIdBansUserId

Route for the /guilds/:guild_id/bans/:user_id path.

The data is the relevant GuildId.

Tuple Fields of GuildsIdBansUserId

0: u64

GuildsIdChannels

Route for the /guilds/:guild_id/channels/:channel_id path.

The data is the relevant GuildId.

Tuple Fields of GuildsIdChannels

0: u64

GuildsIdWidget

Route for the /guilds/:guild_id/widget path.

The data is the relevant GuildId.

Tuple Fields of GuildsIdWidget

0: u64

GuildsIdPreview

Route for the /guilds/:guild_id/preview path.

The data is the relevant GuildPreview.

Tuple Fields of GuildsIdPreview

0: u64

GuildsIdEmojis

Route for the /guilds/:guild_id/emojis path.

The data is the relevant GuildId.

Tuple Fields of GuildsIdEmojis

0: u64

GuildsIdEmojisId

Route for the /guilds/:guild_id/emojis/:emoji_id path.

The data is the relevant GuildId.

Tuple Fields of GuildsIdEmojisId

0: u64

GuildsIdIntegrations

Route for the /guilds/:guild_id/integrations path.

The data is the relevant GuildId.

Tuple Fields of GuildsIdIntegrations

0: u64

GuildsIdIntegrationsId

Route for the /guilds/:guild_id/integrations/:integration_id path.

The data is the relevant GuildId.

Tuple Fields of GuildsIdIntegrationsId

0: u64

GuildsIdIntegrationsIdSync

Route for the /guilds/:guild_id/integrations/:integration_id/sync path.

The data is the relevant GuildId.

Tuple Fields of GuildsIdIntegrationsIdSync

0: u64

GuildsIdInvites

Route for the /guilds/:guild_id/invites path.

The data is the relevant GuildId.

Tuple Fields of GuildsIdInvites

0: u64

GuildsIdMembers

Route for the /guilds/:guild_id/members path.

The data is the relevant GuildId.

Tuple Fields of GuildsIdMembers

0: u64

GuildsIdMembersId

Route for the /guilds/:guild_id/members/:user_id path.

The data is the relevant GuildId.

Tuple Fields of GuildsIdMembersId

0: u64

GuildsIdMembersIdRolesId

Route for the /guilds/:guild_id/members/:user_id/roles/:role_id path.

The data is the relevant GuildId.

Tuple Fields of GuildsIdMembersIdRolesId

0: u64

GuildsIdMembersMe

Route for the /guilds/:guild_id/members/@me path.

The data is the relevant GuildId.

Tuple Fields of GuildsIdMembersMe

0: u64

GuildsIdMembersMeNick

Route for the /guilds/:guild_id/members/@me/nick path.

The data is the relevant GuildId.

Tuple Fields of GuildsIdMembersMeNick

0: u64

GuildsIdMembersSearch

Route for the /guilds/:guild_id/members/search path.

The data is the relevant GuildId.

Tuple Fields of GuildsIdMembersSearch

0: u64

GuildsIdPrune

Route for the /guilds/:guild_id/prune path.

The data is the relevant GuildId.

Tuple Fields of GuildsIdPrune

0: u64

GuildsIdRegions

Route for the /guilds/:guild_id/regions path.

The data is the relevant GuildId.

Tuple Fields of GuildsIdRegions

0: u64

GuildsIdRoles

Route for the /guilds/:guild_id/roles path.

The data is the relevant GuildId.

Tuple Fields of GuildsIdRoles

0: u64

GuildsIdRolesId

Route for the /guilds/:guild_id/roles/:role_id path.

The data is the relevant GuildId.

Tuple Fields of GuildsIdRolesId

0: u64

GuildsIdVanityUrl

Route for the /guilds/:guild_id/vanity-url path.

The data is the relevant GuildId.

Tuple Fields of GuildsIdVanityUrl

0: u64

GuildsIdVoiceStates

Route for the /guilds/:guild_id/voice-states/:user_id path.

The data is the relevant GuildId.

Tuple Fields of GuildsIdVoiceStates

0: u64

GuildsIdVoiceStatesMe

Route for the /guilds/:guild_id/voice-states/@me path.

The data is the relevant GuildId.

Tuple Fields of GuildsIdVoiceStatesMe

0: u64

GuildsIdWebhooks

Route for the /guilds/:guild_id/webhooks path.

The data is the relevant GuildId.

Tuple Fields of GuildsIdWebhooks

0: u64

GuildsIdWelcomeScreen

Route for the /guilds/:guild_id/welcome-screen path.

The data is the relevant GuildId.

Tuple Fields of GuildsIdWelcomeScreen

0: u64

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.

UsersMeConnections

Route for the /users/@me/connections 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

Route for the /webhooks/:webhook_id path.

Tuple Fields of WebhooksId

0: u64

WebhooksIdMessagesId

Route for the /webhooks/:webhook_id/:token/messages/:message_id path.

The data is the relevant WebhookId.

Tuple Fields of WebhooksIdMessagesId

0: u64

WebhooksApplicationId

This is supported on crate feature unstable_discord_api only.

Route for the /webhooks/:application_id path.

The data is the relevant ApplicationId.

Tuple Fields of WebhooksApplicationId

0: u64

InteractionsId

This is supported on crate feature unstable_discord_api only.

Route for the /interactions/:interaction_id path.

The data is the relevant InteractionId.

Tuple Fields of InteractionsId

0: u64

ApplicationsIdCommands

This is supported on crate feature unstable_discord_api only.

Route for the /applications/:application_id path.

The data is the relevant ApplicationId.

Tuple Fields of ApplicationsIdCommands

0: u64

ApplicationsIdCommandsId

This is supported on crate feature unstable_discord_api only.

Route for the /applications/:application_id/commands/:command_id path.

The data is the relevant ApplicationId.

Tuple Fields of ApplicationsIdCommandsId

0: u64

ApplicationsIdGuildsIdCommands

This is supported on crate feature unstable_discord_api only.

Route for the /applications/:application_id/guilds/:guild_id path.

The data is the relevant ApplicationId.

Tuple Fields of ApplicationsIdGuildsIdCommands

0: u64

ApplicationsIdGuildsIdCommandsPermissions

This is supported on crate feature unstable_discord_api only.

Route for the /applications/:application_id/guilds/:guild_id/commands/permissions path.

The data is the relevant ApplicationId.

Tuple Fields of ApplicationsIdGuildsIdCommandsPermissions

0: u64

ApplicationsIdGuildsIdCommandIdPermissions

This is supported on crate feature unstable_discord_api only.

Route for the /applications/:application_id/guilds/:guild_id/commands/:command_id/permissions path.

The data is the relevant ApplicationId.

Tuple Fields of ApplicationsIdGuildsIdCommandIdPermissions

0: u64

ApplicationsIdGuildsIdCommandsId

This is supported on crate feature unstable_discord_api only.

Route for the /applications/:application_id/guilds/:guild_id path.

The data is the relevant ApplicationId.

Tuple Fields of ApplicationsIdGuildsIdCommandsId

0: u64

StageInstances

Route for the /stage-instances path.

The data is the relevant ChannelId.

StageInstancesChannelId

Route for the /stage-instances/:channel_id path.

The data is the relevant ChannelId.

Tuple Fields of StageInstancesChannelId

0: u64

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.

Implementations

impl Route

pub fn channel(channel_id: u64) -> String

pub fn channel_invites(channel_id: u64) -> String

pub fn channel_message(channel_id: u64, message_id: u64) -> String

pub fn channel_message_crosspost(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, 

pub fn channel_message_reaction_emoji<T>(
    channel_id: u64,
    message_id: u64,
    reaction_type: T
) -> String where
    T: Display, 

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

pub fn channel_messages(channel_id: u64, query: Option<&str>) -> String

pub fn channel_messages_bulk_delete(channel_id: u64) -> String

pub fn channel_permission(channel_id: u64, target_id: u64) -> String

pub fn channel_pin(channel_id: u64, message_id: u64) -> String

pub fn channel_pins(channel_id: u64) -> String

pub fn channel_typing(channel_id: u64) -> String

pub fn channel_webhooks(channel_id: u64) -> String

pub fn channel_public_threads(channel_id: u64, message_id: u64) -> String

pub fn channel_private_threads(channel_id: u64) -> String

pub fn channel_thread_member(channel_id: u64, user_id: u64) -> String

pub fn channel_thread_member_me(channel_id: u64) -> String

pub fn channel_thread_members(channel_id: u64) -> String

pub fn channel_active_threads(channel_id: u64) -> String

pub fn channel_archived_public_threads(
    channel_id: u64,
    before: Option<u64>,
    limit: Option<u64>
) -> String

pub fn channel_archived_private_threads(
    channel_id: u64,
    before: Option<u64>,
    limit: Option<u64>
) -> String

pub fn channel_joined_private_threads(
    channel_id: u64,
    before: Option<u64>,
    limit: Option<u64>
) -> String

pub fn gateway() -> &'static str

pub fn gateway_bot() -> &'static str

pub fn guild(guild_id: u64) -> String

pub fn guild_with_counts(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

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

pub fn guild_kick_optioned(guild_id: u64, user_id: u64, reason: &str) -> String

pub fn guild_bans(guild_id: u64) -> String

pub fn guild_channels(guild_id: u64) -> String

pub fn guild_widget(guild_id: u64) -> String

pub fn guild_preview(guild_id: u64) -> String

pub fn guild_emojis(guild_id: u64) -> String

pub fn guild_emoji(guild_id: u64, emoji_id: u64) -> String

pub fn guild_integration(guild_id: u64, integration_id: u64) -> String

pub fn guild_integration_sync(guild_id: u64, integration_id: u64) -> String

pub fn guild_integrations(guild_id: u64) -> String

pub fn guild_invites(guild_id: u64) -> String

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

pub fn guild_members(guild_id: u64) -> String

pub fn guild_members_search(
    guild_id: u64,
    query: &str,
    limit: Option<u64>
) -> String

pub fn guild_members_optioned(
    guild_id: u64,
    after: Option<u64>,
    limit: Option<u64>
) -> String

pub fn guild_member_me(guild_id: u64) -> String

pub fn guild_nickname(guild_id: u64) -> String

pub fn guild_prune(guild_id: u64, days: u64) -> String

pub fn guild_regions(guild_id: u64) -> String

pub fn guild_role(guild_id: u64, role_id: u64) -> String

pub fn guild_roles(guild_id: u64) -> String

pub fn guild_vanity_url(guild_id: u64) -> String

pub fn guild_voice_states(guild_id: u64, user_id: u64) -> String

pub fn guild_voice_states_me(guild_id: u64) -> String

pub fn guild_webhooks(guild_id: u64) -> String

pub fn guild_welcome_screen(guild_id: u64) -> String

pub fn guilds() -> &'static str

pub fn invite(code: &str) -> String

pub fn invite_optioned(code: &str, stats: bool) -> String

pub fn oauth2_application_current() -> &'static str

pub fn private_channel() -> &'static str

pub fn status_incidents_unresolved() -> &'static str

pub fn status_maintenances_active() -> &'static str

pub fn status_maintenances_upcoming() -> &'static str

pub fn user<D: Display>(target: D) -> String

pub fn user_me_connections() -> &'static str

pub fn user_dm_channels<D: Display>(target: D) -> String

pub fn user_guild<D: Display>(target: D, guild_id: u64) -> String

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

pub fn voice_regions() -> &'static str

pub fn webhook(webhook_id: u64) -> String

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, 

pub fn webhook_message<D>(webhook_id: u64, token: D, message_id: u64) -> String where
    D: Display, 

pub fn webhook_original_interaction_response<D: Display>(
    application_id: u64,
    token: D
) -> String

This is supported on crate feature unstable_discord_api only.

pub fn webhook_followup_message<D: Display>(
    application_id: u64,
    token: D,
    message_id: u64
) -> String

This is supported on crate feature unstable_discord_api only.

pub fn webhook_followup_messages<D: Display>(
    application_id: u64,
    token: D
) -> String

This is supported on crate feature unstable_discord_api only.

pub fn interaction_response<D: Display>(application_id: u64, token: D) -> String

This is supported on crate feature unstable_discord_api only.

pub fn application_command(application_id: u64, command_id: u64) -> String

This is supported on crate feature unstable_discord_api only.

pub fn application_commands(application_id: u64) -> String

This is supported on crate feature unstable_discord_api only.

pub fn application_guild_command(
    application_id: u64,
    guild_id: u64,
    command_id: u64
) -> String

This is supported on crate feature unstable_discord_api only.

pub fn application_guild_command_permissions(
    application_id: u64,
    guild_id: u64,
    command_id: u64
) -> String

This is supported on crate feature unstable_discord_api only.

pub fn application_guild_commands(application_id: u64, guild_id: u64) -> String

This is supported on crate feature unstable_discord_api only.

pub fn application_guild_commands_permissions(
    application_id: u64,
    guild_id: u64
) -> String

This is supported on crate feature unstable_discord_api only.

pub fn stage_instances() -> String

pub fn stage_instance(channel_id: u64) -> String

Trait Implementations

impl Clone for Route

fn clone(&self) -> Route

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Route

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Hash for Route

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<Route> for Route

fn eq(&self, other: &Route) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Route) -> bool

This method tests for !=.

impl Copy for Route

impl Eq for Route

impl StructuralEq for Route

impl StructuralPartialEq for Route