Struct restson::RestClient

pub struct RestClient { /* fields omitted */ }

REST client to make HTTP GET and POST requests.

Implementations

impl RestClient

pub fn new(url: &str) -> Result<RestClient, Error>

Construct new client with default configuration to make HTTP requests.

Use Builder to configure the client.

pub fn builder() -> Builder

Configure a client

pub fn set_send_null_body(&mut self, send_null: bool)

Set whether a message body consisting only 'null' (from serde serialization) is sent in POST/PUT

pub fn set_auth(&mut self, user: &str, pass: &str)

Set credentials for HTTP Basic authentication.

pub fn set_body_wash_fn(&mut self, func: fn(_: String) -> String)

Set a function that cleans the response body up before deserializing it.

pub fn set_timeout(&mut self, timeout: Duration)

Set request timeout

pub fn set_header(
    &mut self,
    name: &'static str,
    value: &str
) -> Result<(), Error>

Set HTTP header from string name and value.

The header is added to all subsequent GET and POST requests unless the headers are cleared with clear_headers() call.

pub fn clear_headers(&mut self)

Clear all previously set headers

pub fn response_headers(&mut self) -> &HeaderMap

Response headers captured from previous request

pub fn get<U, T>(&mut self, params: U) -> Result<T, Error> where
    T: DeserializeOwned + RestPath<U>, 

Make a GET request.

pub fn get_with<U, T>(
    &mut self,
    params: U,
    query: &Query<'_>
) -> Result<T, Error> where
    T: DeserializeOwned + RestPath<U>, 

Make a GET request with query parameters.

pub fn post<U, T>(&mut self, params: U, data: &T) -> Result<(), Error> where
    T: Serialize + RestPath<U>, 

Make a POST request.

pub fn put<U, T>(&mut self, params: U, data: &T) -> Result<(), Error> where
    T: Serialize + RestPath<U>, 

Make a PUT request.

pub fn patch<U, T>(&mut self, params: U, data: &T) -> Result<(), Error> where
    T: Serialize + RestPath<U>, 

Make a PATCH request.

pub fn post_with<U, T>(
    &mut self,
    params: U,
    data: &T,
    query: &Query<'_>
) -> Result<(), Error> where
    T: Serialize + RestPath<U>, 

Make POST request with query parameters.

pub fn put_with<U, T>(
    &mut self,
    params: U,
    data: &T,
    query: &Query<'_>
) -> Result<(), Error> where
    T: Serialize + RestPath<U>, 

Make PUT request with query parameters.

pub fn patch_with<U, T>(
    &mut self,
    params: U,
    data: &T,
    query: &Query<'_>
) -> Result<(), Error> where
    T: Serialize + RestPath<U>, 

Make PATCH request with query parameters.

pub fn post_capture<U, T, K>(&mut self, params: U, data: &T) -> Result<K, Error> where
    T: Serialize + RestPath<U>,
    K: DeserializeOwned, 

Make a POST request and capture returned body.

pub fn put_capture<U, T, K>(&mut self, params: U, data: &T) -> Result<K, Error> where
    T: Serialize + RestPath<U>,
    K: DeserializeOwned, 

Make a PUT request and capture returned body.

pub fn post_capture_with<U, T, K>(
    &mut self,
    params: U,
    data: &T,
    query: &Query<'_>
) -> Result<K, Error> where
    T: Serialize + RestPath<U>,
    K: DeserializeOwned, 

Make a POST request with query parameters and capture returned body.

pub fn put_capture_with<U, T, K>(
    &mut self,
    params: U,
    data: &T,
    query: &Query<'_>
) -> Result<K, Error> where
    T: Serialize + RestPath<U>,
    K: DeserializeOwned, 

Make a PUT request with query parameters and capture returned body.

pub fn delete<U, T>(&mut self, params: U) -> Result<(), Error> where
    T: RestPath<U>, 

Make a DELETE request.

pub fn delete_with<U, T>(
    &mut self,
    params: U,
    data: &T,
    query: &Query<'_>
) -> Result<(), Error> where
    T: Serialize + RestPath<U>, 

Make a DELETE request with query and body.