Struct RequestConfig 

pub struct RequestConfig {
    pub url: StringSource,
    pub method: Method,
    pub headers: HashMap<String, StringSource>,
    pub body: Option<RequestBody>,
    pub response_handler: ResponseHandler,
    pub client_config_diff: Option<HttpClientConfigDiff>,
}

Rules for making an HTTP request.

Currently only capable of making blocking requests.

Fields

url: StringSource

The URL to send the request to.

Defaults to StringSource::Part(UrlPart::Whole).

method: Method

The method to use.

Defaults to Method::GET.

headers: HashMap<String, StringSource>

The headers to send in addition to the default headers from the HttpClientConfig and Self::client_config_diff.

If a call to StringSource::get returns None, the header it came from isn’t sent. This can be useful for API keys.

Defaults to an empty set.

body: Option<RequestBody>

The body to send.

Defaults to None.

response_handler: ResponseHandler

What to part of the response to return.

Defaults to ResponseHandler::Body.

client_config_diff: Option<HttpClientConfigDiff>

Overrides for the HttpClientConfig this uses to make the reqwest::blocking::Client.

Implementations

impl RequestConfig

pub fn make( &self, task_state: &TaskStateView<'_>, ) -> Result<RequestBuilder, MakeHttpRequestError>

Makes the request.

Errors

If the call to TaskStateView::http_client returns an error, that error is returned.

If Self::url’s call to StringSource::get returns an error, that error is returned.

If Self::url’s call to StringSource::get returns None, returns the error MakeHttpRequestError::StringSourceIsNone.

If any of Self::headers’s calls to StringSource::get return an error, that error is returned.

If any of Self::headers’s calls to HeaderName::try_from returns an error, that error is returned.

If the call to RequestBody::apply returns an error, that error is returned.

pub fn send( &self, task_state: &TaskStateView<'_>, ) -> Result<Response, SendHttpRequestError>

Makes and sends the request.

Errors

If the call to Self::make returns an error, that error is returned.

If the call to reqwest::blocking::RequestBuilder::send returns an error, that error is returned.

pub fn response( &self, task_state: &TaskStateView<'_>, ) -> Result<String, HttpResponseError>

Make the request, send it, and return the response specified by Self::response_handler.

Errors

If the call to Self::send returns an error, that error is returned.

If the call to [RequestHandler::handle} returns an error, that error is returned.

Trait Implementations

impl Clone for RequestConfig

fn clone(&self) -> RequestConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RequestConfig

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

Formats the value using the given formatter.

impl Default for RequestConfig

fn default() -> RequestConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RequestConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for RequestConfig

fn eq(&self, other: &RequestConfig) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for RequestConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for RequestConfig

impl StructuralPartialEq for RequestConfig