Struct twilight_http::request::Request

pub struct Request {
    pub body: Option<Vec<u8>>,
    pub form: Option<Form>,
    pub headers: Option<HeaderMap<HeaderValue>>,
    pub method: Method,
    pub path: Path,
    pub path_str: Cow<'static, str>,
    // some fields omitted
}

Fields

body: Option<Vec<u8>>

The body of the request, if any.

form: Option<Form>

The multipart form of the request, if any.

headers: Option<HeaderMap<HeaderValue>>

The headers to set in the request, if any.

method: Method

The method of the request.

path: Path

The ratelimiting bucket path.

path_str: Cow<'static, str>

The URI path to request.

Implementations

impl Request

pub fn new(
    body: Option<Vec<u8>>,
    headers: Option<HeaderMap<HeaderValue>>,
    route: Route
) -> Self

👎 Deprecated since 0.4.0:

Use Request::builder instead

Create a simple Request with basic information.

Use the RequestBuilder if you need to set a combination of configurations in the request.

pub fn builder(route: Route) -> RequestBuilder

Create a new request builder.

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

pub fn from_route(route: Route) -> Self

Create a request from only its route information.

If you need to set additional configurations like the body then use builder.

Examples

Create a request to get a message with an ID of 2 in a channel with an ID of 1:

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

let request = Request::from_route(Route::GetMessage {
    channel_id: 1,
    message_id: 2,
});

pub const fn use_authorization_token(&self) -> bool

Whether to use the client’s authorization token in the request.

Trait Implementations

impl Debug for Request

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

Formats the value using the given formatter.

impl From<(Form, HeaderMap<HeaderValue>, Route)> for Request

fn from((form, headers, route): (Form, HeaderMap<HeaderValue>, Route)) -> Self

Performs the conversion.

impl From<(Form, Route)> for Request

fn from((form, route): (Form, Route)) -> Self

Performs the conversion.

impl From<(HeaderMap<HeaderValue>, Route)> for Request

fn from((headers, route): (HeaderMap<HeaderValue>, Route)) -> Self

Performs the conversion.

impl From<(Vec<u8, Global>, Form, Route)> for Request

fn from((body, form, route): (Vec<u8>, Form, Route)) -> Self

Performs the conversion.

impl From<(Vec<u8, Global>, HeaderMap<HeaderValue>, Route)> for Request

fn from(
    (body, headers, route): (Vec<u8>, HeaderMap<HeaderValue>, Route)
) -> Self

Performs the conversion.

impl From<(Vec<u8, Global>, Route)> for Request

fn from((body, route): (Vec<u8>, Route)) -> Self

Performs the conversion.

impl From<Route> for Request

fn from(route: Route) -> Self

Performs the conversion.