Struct elastic::client::sender::RequestParams

pub struct RequestParams { /* fields omitted */ }

Parameters for a single REST API request.

The RequestParams struct allows you to set headers and url parameters for a given request. 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:

use elastic::http::header::{self, AUTHORIZATION, HeaderValue};

let auth = HeaderValue::from_str("let me in")?;

let params = RequestParams::default()
    .header(AUTHORIZATION, auth);

With url query parameters:

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

Methods

impl RequestParams

pub fn from_parts(
    base_url: impl Into<NodeAddress>,
    inner: PreRequestParams
) -> Self

Create a container for request parameters from a base url and pre request parameters.

pub fn new(base_url: impl Into<NodeAddress>) -> 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.

pub fn base_url(self, base_url: impl Into<NodeAddress>) -> Self

Set the base url for the Elasticsearch node.

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

Set a url param value.

These parameters are added as query parameters to request urls.

pub fn header(self, key: HeaderName, value: HeaderValue) -> Self

Set a request header.

pub fn get_base_url(&self) -> &str

Get the base url.

pub 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.

pub fn split(self) -> (NodeAddress, PreRequestParams)

Split the request parameters into its parts.

Trait Implementations

impl Default for RequestParams

fn default() -> Self

Returns the "default value" for a type.

impl From<RequestParams> for PendingParams

fn from(params: RequestParams) -> Self

Performs the conversion.

impl From<RequestParams> for Params

fn from(params: RequestParams) -> Self

Performs the conversion.

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.