Struct twilight_http::request::RequestBuilder

pub struct RequestBuilder(_);

Builder to create a customized request.

Examples

Create a request to create a message with a content of “test” in a channel with an ID of 1:

use twilight_http::{request::Request, routing::Route};

let body = br#"{
    "content": "test"
}"#.to_vec();

let request = Request::builder(Route::CreateMessage {
    channel_id: 1,
}).body(body).build();

Implementations

impl RequestBuilder

pub fn new(route: Route) -> Self

Create a new request builder.

pub const fn raw(method: Method, path: Path, path_and_query: String) -> Self

Create a request with raw information about the method, ratelimiting path, and URL path and query.

The path and query should not include the leading slash as that is prefixed by the client. In the URL https://discord.com/api/vX/channels/123/pins the “path and query” is considered to be channels/123/pins.

Examples

Create a request from a method and the URL path and query channels/123/pins:

use std::str::FromStr;
use twilight_http::{request::{Method, RequestBuilder}, routing::Path};

let method = Method::Post;
let path_and_query = "channels/123/pins".to_owned();
let ratelimit_path = Path::from_str(&path_and_query)?;

let _request = RequestBuilder::raw(
    method,
    ratelimit_path,
    path_and_query,
).build();

pub fn build(self) -> Request

Consume the builder, returning the built request.

pub fn body(self, body: Vec<u8>) -> Self

Set the contents of the body.

pub fn form(self, form: Form) -> Self

Set the multipart form.

pub fn headers(
    self,
    iter: impl Iterator<Item = (HeaderName, HeaderValue)>
) -> Self

Set the headers to add.

pub fn json(self, to: &impl Serialize) -> Result<Self, Error>

Set the body, to be serialized as JSON.

Errors

Returns an ErrorType::Json error type if the value could not be serialized as JSON.

pub const fn use_authorization_token(
    self,
    use_authorization_token: bool
) -> Self

Whether to use the client’s authorization token in the request, if one is set.

This is primarily useful for executing webhooks.

Trait Implementations

impl Debug for RequestBuilder

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

Formats the value using the given formatter.