Struct restson::RestClient

source ·

pub struct RestClient { /* private fields */ }

Expand description

REST client to make HTTP GET and POST requests.

Implementations

source

impl RestClient

source

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

Construct new client with default configuration to make HTTP requests.

Use Builder to configure the client.

source

pub fn builder() -> Builder

Configure a client

source

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

source

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

Set credentials for HTTP Basic authentication.

source

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

Set request timeout

source

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.

source

pub fn clear_headers(&mut self)

Clear all previously set headers

source

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

Make a GET request.

source

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

Make a GET request with query parameters.

source

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

Make a POST request.

source

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

Make a PUT request.

source

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

Make a PATCH request.

source

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

Make POST request with query parameters.

source

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

Make PUT request with query parameters.

source

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

Make PATCH request with query parameters.

source

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

Make a POST request and capture returned body.

source

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

Make a PUT request and capture returned body.

source

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

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

source

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

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

source

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

Make a DELETE request.

source

pub fn make_request<U, T>(
 &mut self,
 method: Method,
 params: U,
 query: Option<&Query<'_>>,
 body: Option<String>
) -> Result<Request<Body>, Error>where
 T: RestPath,

Auto Trait Implementations

impl !RefUnwindSafe for RestClient

impl !Send for RestClient

impl !Sync for RestClient

impl Unpin for RestClient

impl !UnwindSafe for RestClient

Blanket Implementations

source

impl<T> Any for Twhere
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for Twhere
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T, U> TryFrom for Twhere
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for Twhere
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct restson::RestClient

Implementations

impl RestClient

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

pub fn builder() -> Builder

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

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

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

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

pub fn clear_headers(&mut self)

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

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

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

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

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

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

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

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

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

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

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,

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,

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

pub fn make_request<U, T>( &mut self, method: Method, params: U, query: Option<&Query<'_>>, body: Option<String>) -> Result<Request<Body>, Error>where T: RestPath<U>,

Auto Trait Implementations

impl !RefUnwindSafe for RestClient

impl !Send for RestClient

impl !Sync for RestClient

impl Unpin for RestClient

impl !UnwindSafe for RestClient

Blanket Implementations

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for Twhere U: From<T>,

fn into(self) -> U

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

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

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

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

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

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

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

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

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

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

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

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,

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,

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

pub fn make_request<U, T>(
&mut self,
method: Method,
params: U,
query: Option<&Query<'_>>,
body: Option<String>
) -> Result<Request<Body>, Error>where
T: RestPath<U>,

impl<T> Any for Twhere
T: 'static + ?Sized,

impl<T> Borrow<T> for Twhere
T: ?Sized,

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

impl<T, U> Into<U> for Twhere
U: From<T>,

impl<T, U> TryFrom<U> for Twhere
U: Into<T>,

impl<T, U> TryInto<U> for Twhere
U: TryFrom<T>,