Trait api_request_utils_rs::RequestDefaults

source · 
pub trait RequestDefaults: RequestModifiers {
    // Required method
    fn client(&self) -> &Client;

    // Provided methods
    fn default_headers(&self, request_builder: RequestBuilder) -> RequestBuilder { ... }
    fn default_parameters(
        &self,
        request_builder: RequestBuilder
    ) -> RequestBuilder { ... }
    fn default_post_requestor(
        &self,
        endpoint: &str,
        json: &str
    ) -> RequestBuilder { ... }
    fn default_get_requestor<'a>(
        &self,
        endpoint: &str,
        parameters: ParameterHashMap<'a>
    ) -> RequestBuilder { ... }
}
Expand description

The RequestDefaults trait provides default methods for configuring and modifying HTTP requests.

Required Methods§

source

fn client(&self) -> &Client

Returns the reqwest::Client instance associated with the API client.

The client is used to send HTTP requests to the API.

Examples
fn main() {
    let api_client = APIClient::new();
    let client = api_client.client();

    // Use the client to make HTTP requests
    // ...
}

Provided Methods§

source

fn default_headers(&self, request_builder: RequestBuilder) -> RequestBuilder

Modifies the provided RequestBuilder with default headers.

Arguments
  • request_builder - The RequestBuilder to modify.
Returns

The modified RequestBuilder with default headers set.

source

fn default_parameters(&self, request_builder: RequestBuilder) -> RequestBuilder

Modifies the provided RequestBuilder with default parameters.

Arguments
  • request_builder - The RequestBuilder to modify.
Returns

The modified RequestBuilder with default parameters set.

source

fn default_post_requestor(&self, endpoint: &str, json: &str) -> RequestBuilder

Modifies the provided RequestBuilder with default settings for post request.

Arguments
  • endpoint - The endpoint for the request.
  • json - The JSON payload for the request.
Returns

The modified RequestBuilder with default settings applied.

source

fn default_get_requestor<'a>( &self, endpoint: &str, parameters: ParameterHashMap<'a> ) -> RequestBuilder

Modifies the provided RequestBuilder with default settings for get request.

Arguments
  • endpoint - The endpoint for the request.
  • parameters - The Parameters for the request.
Returns

The modified RequestBuilder with default settings applied.

Implementors§