Struct elastic_reqwest::RequestParams

pub struct RequestParams { /* fields omitted */ }

Misc parameters for any request.

The RequestParams struct allows you to set headers and url parameters for your requests. By default, the ContentType::json header will always be added. Url parameters are added as simple key-value pairs, and serialised by rust-url.

Examples

With default query parameters:

let params = RequestParams::default();

With a custom base url:

let params = RequestParams::new("http://mybaseurl:9200");

With custom headers:

let params = RequestParams::default()
    .header(Authorization("let me in".to_owned()));

With url query parameters:

let params = RequestParams::default()
    .url_param("pretty", true)
    .url_param("q", "*");

Methods

impl RequestParams

fn new<T: Into<String>>(base: T) -> Self

Create a new container for request parameters.

This method takes a fully-qualified url for the Elasticsearch node. It will also set the Content-Type header to application/json.

fn base_url<T: Into<String>>(self, base: T) -> Self

Set the base url for the Elasticsearch node.

fn url_param<T: ToString>(self, key: &'static str, value: T) -> Self

Set a url param value.

These parameters are added as query parameters to request urls.

fn header<H>(self, header: H) -> Self where
    H: Header + Clone, 

Set a request header.

fn get_base_url(&self) -> &str

Get the base url.

fn get_headers(&self) -> Headers

Create a new Headers structure, and thread it through the configuration functions.

fn get_url_qry(&self) -> (usize, Option<String>)

Get the url query params as a formatted string.

Follows the application/x-www-form-urlencoded format. This method returns the length of the query string and an optional value. If the value is None, then the length will be 0.

Trait Implementations

impl Clone for RequestParams

fn clone(&self) -> RequestParams

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for RequestParams

fn default() -> Self

Returns the "default value" for a type.