Struct brawl_api::http::request::Request

pub struct Request<'a> {
    pub body: Option<&'a [u8]>,
    pub headers: Option<HeaderMap>,
    pub endpoint: String,
    pub method: Method,
}

A struct representing a request to some endpoint.

Fields

body: Option<&'a [u8]>

The body of the request. (Note that this is rarely, if ever, used in this lib.)

headers: Option<HeaderMap>

The headers of the request.

endpoint: String

The endpoint (e.g. /players/%23sometag).

method: Method

The method (GET/POST/...). Defaults to GET

Methods

impl<'a> Request<'a>

pub fn build(&'a self, client: &Client) -> Result<RequestBuilder>

(For sync usage) Creates a (blocking) RequestBuilder (reqwest crate) instance.

pub fn a_build(&'a self, client: &Client) -> Result<ARequestBuilder>

(For async usage) Creates a (non-blocking) RequestBuilder (reqwest crate) instance.

Trait Implementations

impl<'a> Clone for Request<'a>

fn clone(&self) -> Request<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Request<'a>

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

Formats the value using the given formatter.

impl<'a> Default for Request<'a>

fn default() -> Request<'a>

Returns a default Request instance, with initial values.

Examples

use brawl_api::http::request::Request;
use reqwest::Method;

assert_eq!(
    Request::default(),
    Request {
        body: None,
        headers: None,
        endpoint: String::from(""),
        method: Method::GET,
    }
)

impl<'a> Eq for Request<'a>

impl<'a> PartialEq<Request<'a>> for Request<'a>

fn eq(&self, other: &Request<'a>) -> bool

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

fn ne(&self, other: &Request<'a>) -> bool

This method tests for !=.

impl<'a> StructuralEq for Request<'a>

impl<'a> StructuralPartialEq for Request<'a>