Struct Request

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

Implementations

impl<'a> Request<'a>

pub fn builder() -> RequestBuilder<'a>

Create a builder for the endpoint.

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 RestEndpoint for Request<'_>

fn request_headers(&self) -> Option<&HeaderMap>

Returns headers to be set into the request

fn api_version(&self) -> Option<ApiVersion>

Returns required API version

fn method(&self) -> Method

The HTTP method to use for the endpoint.

fn endpoint(&self) -> Cow<'static, str>

The path to the endpoint.

fn parameters(&self) -> QueryParams<'_>

Query parameters for the endpoint.

fn body(&self) -> Result<Option<(&'static str, Vec<u8>)>, BodyError>

The body for the endpoint.

fn service_type(&self) -> ServiceType

The endpoint service type.

fn response_key(&self) -> Option<Cow<'static, str>>

Returns response key under which the data is expected

fn response_list_item_key(&self) -> Option<Cow<'static, str>>

Returns response key under which the list item data is expected (i.e. {"list": ["item":{}, "item": {}}

fn response_headers(&self) -> HashMap<&str, &str>

Returns map of headers to capture from the endpoint response to the names in the target result struct.