Struct ably::http::RequestBuilder

pub struct RequestBuilder<'a> { /* private fields */ }

A builder to construct a HTTP request to the Ably REST API.

Implementations

impl<'a> RequestBuilder<'a>

pub fn new(rest: &'a Rest, inner: RequestBuilder, format: Format) -> Self

pub fn format(self, format: Format) -> Self

Set the request format.

pub fn params<T: Serialize + ?Sized>(self, params: &T) -> Self

Modify the query params of the request, adding the parameters provided.

pub fn body<T: Serialize + ?Sized>(self, body: &T) -> Self

Set the request body.

pub fn authenticate(self, authenticate: bool) -> Self

pub fn headers(self, headers: HeaderMap) -> Self

Add a set of HTTP headers to the request.

pub fn basic_auth<U: Display, P: Display>(
    self,
    username: U,
    password: Option<P>
) -> Self

pub fn bearer_auth<T: Display>(self, token: T) -> Self

pub async fn send(self) -> Result<Response>

Send the request to the Ably REST API.