Struct wwsvc_rs::client::WebwareClient

pub struct WebwareClient { /* fields omitted */ }

The web client to consume SoftENGINE’s WEBSERVICES

Implementations

impl WebwareClient

pub fn create_cursor(&mut self, max_lines: u32)

Creates a new pagination cursor and makes it available for the next requests (until it is closed)

pub fn set_result_max_lines(&mut self, max_lines: u32)

Sets the maximum amount of results that are returned in a response

pub fn get_default_headers(
    &mut self,
    additional_headers: Option<HashMap<&str, &str>>
) -> HeaderMap

Returns a set of headers, that are required on all requests to the WEBSERVICES (except REGISTER).

This will automatically append necessary authentication headers and increase the request ID, if register() was successful.

pub fn get_bin_headers(
    &mut self,
    additional_headers: Option<HashMap<&str, &str>>
) -> HeaderMap

Returns the same set of headers, that get_default_headers() returns, except the result type header is set to BIN instead.

pub fn build_url(&self, parts: Vec<String>) -> String

Builds a valid WEBSERVICES URL from URL parts

pub fn register(&mut self) -> Result<bool, Box<dyn Error>>

Sends a REGISTER request to the WEBWARE instance and returns whether the request succeeded or not.

If the result is not true, the client has no valid service pass and cannot perform requests!

pub fn deregister(&mut self) -> bool

Sends a DEREGISTER request to the WEBWARE instance, in order to invalidate the service pass.

If the client was not authenticated using register() before, it will instead just return true;

pub fn request(
    &mut self,
    method: Method,
    function: &str,
    version: u32,
    parameters: HashMap<&str, &str>,
    additional_headers: Option<HashMap<&str, &str>>
) -> Result<Value, Box<dyn Error>>

Performs a request to the WEBSERVICES and returns a JSON value.

pub fn request_as_response(
    &mut self,
    method: Method,
    function: &str,
    version: u32,
    parameters: HashMap<&str, &str>,
    additional_headers: Option<HashMap<&str, &str>>
) -> Result<Response, Box<dyn Error>>

Performs a request to the WEBSERVICES and returns a response object.

pub fn request_generic<T>(
    &mut self,
    method: Method,
    function: &str,
    version: u32,
    parameters: HashMap<&str, &str>,
    additional_headers: Option<HashMap<&str, &str>>
) -> Result<T, Box<dyn Error>> where
    T: DeserializeOwned, 

Performs a request to the WEBSERVICES and deserializes the response to the type T.

Discards headers from responses to directly deserialize.

NOTE: Due to the nature of the WEBSERVICES, deserialization might fail due to structural issues. In that case, use request() instead.