Struct Endpoint 

pub struct Endpoint {
    pub method: Method,
    pub path: String,
}

Rate limited endpoint.

The rate limiter dynamically supports new or unknown API paths, but is consequently unable to catch invalid arguments. Invalidly structured endpoints may be permitted at an improper time.

Example

use twilight_http_ratelimiting::{Endpoint, Method};

let url = "https://discord.com/api/v10/guilds/745809834183753828/audit-logs?limit=10";
let endpoint = Endpoint {
    method: Method::Get,
    path: String::from("guilds/745809834183753828/audit-logs"),
};
let permit = rate_limiter.acquire(endpoint).await;
let headers = unimplemented!("GET {url}");
permit.complete(headers);

Fields

method: Method

Method of the endpoint.

path: String

API path of the endpoint.

Should not start with a slash (/) or include query parameters (?key=value).

Trait Implementations

impl Clone for Endpoint

fn clone(&self) -> Endpoint

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Endpoint

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

Formats the value using the given formatter.

impl Hash for Endpoint

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Endpoint

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Endpoint

impl StructuralPartialEq for Endpoint