Enum twilight_http::routing::Path

#[non_exhaustive]pub enum Path {
    ChannelsId(u64),
    ChannelsIdInvites(u64),
    ChannelsIdMessages(u64),
    ChannelsIdMessagesBulkDelete(u64),
    ChannelsIdMessagesId(Method, u64),
    ChannelsIdMessagesIdCrosspost(u64),
    ChannelsIdMessagesIdReactions(u64),
    ChannelsIdMessagesIdReactionsUserIdType(u64),
    ChannelsIdPermissionsOverwriteId(u64),
    ChannelsIdPins(u64),
    ChannelsIdPinsMessageId(u64),
    ChannelsIdTyping(u64),
    ChannelsIdWebhooks(u64),
    ChannelsIdFollowers(u64),
    Gateway,
    GatewayBot,
    Guilds,
    GuildsId(u64),
    GuildsIdBans(u64),
    GuildsIdBansId(u64),
    GuildsIdAuditLogs(u64),
    GuildsIdBansUserId(u64),
    GuildsIdChannels(u64),
    GuildsIdWidget(u64),
    GuildsIdEmojis(u64),
    GuildsIdEmojisId(u64),
    GuildsIdIntegrations(u64),
    GuildsIdIntegrationsId(u64),
    GuildsIdIntegrationsIdSync(u64),
    GuildsIdInvites(u64),
    GuildsIdMembers(u64),
    GuildsIdMembersId(u64),
    GuildsIdMembersIdRolesId(u64),
    GuildsIdMembersMeNick(u64),
    GuildsIdPreview(u64),
    GuildsIdPrune(u64),
    GuildsIdRegions(u64),
    GuildsIdRoles(u64),
    GuildsIdRolesId(u64),
    GuildsIdVanityUrl(u64),
    GuildsIdWebhooks(u64),
    InvitesCode,
    UsersId,
    OauthApplicationsMe,
    UsersIdConnections,
    UsersIdChannels,
    UsersIdGuilds,
    UsersIdGuildsId,
    VoiceRegions,
    WebhooksId(u64),
}

An enum representing a path, most useful for ratelimiting implementations.

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(u64)

Operating on a channel.

ChannelsIdInvites(u64)

Operating on a channel's invites.

ChannelsIdMessages(u64)

Operating on a channel's messages.

ChannelsIdMessagesBulkDelete(u64)

Operating on a channel's messages by bulk deleting.

ChannelsIdMessagesId(Method, u64)

Operating on an individual channel's message.

ChannelsIdMessagesIdCrosspost(u64)

Crossposting an individual channel's message.

ChannelsIdMessagesIdReactions(u64)

Operating on an individual channel's message's reactions.

ChannelsIdMessagesIdReactionsUserIdType(u64)

Operating on an individual channel's message's reactions while specifying the user ID and emoji type.

ChannelsIdPermissionsOverwriteId(u64)

Operating on a channel's permission overwrites by ID.

ChannelsIdPins(u64)

Operating on a channel's pins.

ChannelsIdPinsMessageId(u64)

Operating on a channel's individual pinned message.

ChannelsIdTyping(u64)

Operating on a channel's typing indicator.

ChannelsIdWebhooks(u64)

Operating on a channel's webhooks.

ChannelsIdFollowers(u64)

Operating on a channel's followers.

Gateway

Operating with the gateway information.

GatewayBot

Operating with the gateway information tailored to the current user.

Guilds

Operating on the guild resource.

GuildsId(u64)

Operating on one of user's guilds.

GuildsIdBans(u64)

GuildsIdBansId(u64)

GuildsIdAuditLogs(u64)

GuildsIdBansUserId(u64)

GuildsIdChannels(u64)

GuildsIdWidget(u64)

GuildsIdEmojis(u64)

GuildsIdEmojisId(u64)

GuildsIdIntegrations(u64)

GuildsIdIntegrationsId(u64)

GuildsIdIntegrationsIdSync(u64)

GuildsIdInvites(u64)

GuildsIdMembers(u64)

GuildsIdMembersId(u64)

GuildsIdMembersIdRolesId(u64)

GuildsIdMembersMeNick(u64)

GuildsIdPreview(u64)

GuildsIdPrune(u64)

GuildsIdRegions(u64)

GuildsIdRoles(u64)

GuildsIdRolesId(u64)

GuildsIdVanityUrl(u64)

GuildsIdWebhooks(u64)

InvitesCode

UsersId

OauthApplicationsMe

UsersIdConnections

UsersIdChannels

UsersIdGuilds

Operating on the state of a guild that the user is in.

UsersIdGuildsId

Operating on the state of a guild that the user is in.

VoiceRegions

Operating on the voice regions available to the current user.

WebhooksId(u64)

Operating on a webhook.

Trait Implementations

impl Clone for Path

pub fn clone(&self) -> Path

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Path

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

Formats the value using the given formatter.

impl Eq for Path

impl FromStr for Path

type Err = PathParseError

The associated error which can be returned from parsing.

pub fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string into a path.

The string may start with a slash (/), which will be ignored.

Examples

use twilight_http::routing::Path;
use std::str::FromStr;

assert_eq!(Path::VoiceRegions, Path::from_str("/voice/regions")?);
assert_eq!(
    Path::ChannelsIdMessages(123),
    Path::from_str("channels/123/messages")?,
);

impl Hash for Path

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl PartialEq<Path> for Path

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

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

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

This method tests for !=.

impl StructuralEq for Path

impl StructuralPartialEq for Path

impl<'_> TryFrom<(Method, &'_ str)> for Path

type Error = PathParseError

The type returned in the event of a conversion error.

pub fn try_from((method, s): (Method, &str)) -> Result<Self, Self::Error>

Performs the conversion.