tadpole - v2026.2.0

tadpole/rest

REST request builders, rate-limit header parsing, response checks. Rate-limit state is derived from response headers and 429 bodies, never from a hardcoded table.

Types

Method

</> 
pub type Method {
  GET
  POST
  PUT
  DELETE
  PATCH
  HEAD
  OPTIONS
}

Constructors 

  • GET
  • POST
  • PUT
  • DELETE
  • PATCH
  • HEAD
  • OPTIONS

RateLimitHeaders

</> 
pub type RateLimitHeaders {
  RateLimitHeaders(
    limit: option.Option(Int),
    remaining: option.Option(Int),
    reset: option.Option(Int),
    reset_after: option.Option(Float),
    bucket: option.Option(String),
    retry_after: option.Option(Int),
    is_global: Bool,
  )
}

Constructors

RestClient

</> 
pub type RestClient {
  RestClient(
    token: String,
    timeout_ms: Int,
    retry_on_429: Bool,
    max_retries: Int,
  )
}

Constructors 

  • RestClient(
  token: String,
  timeout_ms: Int,
  retry_on_429: Bool,
  max_retries: Int,
)

RestRequest

</> 
pub type RestRequest {
  RestRequest(
    method: Method,
    path: String,
    headers: List(#(String, String)),
    body: option.Option(String),
    audit_log_reason: option.Option(String),
  )
}

Constructors

RestResponse

</> 
pub type RestResponse {
  RestResponse(
    status: Int,
    headers: List(#(String, String)),
    body: String,
    rate_limit_headers: option.Option(RateLimitHeaders),
  )
}

Constructors

Values

authorization_header

</> 
pub fn authorization_header(token: String) -> #(String, String)

delete

</> 
pub fn delete(path: String) -> RestRequest

get

</> 
pub fn get(path: String) -> RestRequest
</> 
pub fn header(
  headers: List(#(String, String)),
  name: String,
) -> option.Option(String)

Case-insensitive: HTTP header names are case-insensitive per spec, and proxies/clients normalize casing unpredictably.

is_client_error

</> 
pub fn is_client_error(response: RestResponse) -> Bool

is_forbidden

</> 
pub fn is_forbidden(response: RestResponse) -> Bool

is_not_found

</> 
pub fn is_not_found(response: RestResponse) -> Bool

is_ok

</> 
pub fn is_ok(response: RestResponse) -> Bool

is_rate_limited

</> 
pub fn is_rate_limited(response: RestResponse) -> Bool

is_server_error

</> 
pub fn is_server_error(response: RestResponse) -> Bool

is_unauthorized

</> 
pub fn is_unauthorized(response: RestResponse) -> Bool

new_client

</> 
pub fn new_client(
  token: String,
  timeout_ms: Int,
  retry_on_429: Bool,
  max_retries: Int,
) -> RestClient

parse_rate_limit_headers

</> 
pub fn parse_rate_limit_headers(
  headers: List(#(String, String)),
) -> RateLimitHeaders

Discord may omit any of these headers; each degrades to None.

patch

</> 
pub fn patch(path: String, body: String) -> RestRequest

post

</> 
pub fn post(path: String, body: String) -> RestRequest

put

</> 
pub fn put(path: String, body: String) -> RestRequest

with_audit_log_reason

</> 
pub fn with_audit_log_reason(
  request: RestRequest,
  reason: String,
) -> RestRequest

with_header

</> 
pub fn with_header(
  request: RestRequest,
  name: String,
  value: String,
) -> RestRequest
✨ Search Document