Struct generic_api_client::http::RequestConfig

#[non_exhaustive]
pub struct RequestConfig {
    pub max_try: u8,
    pub retry_cooldown: Duration,
    pub timeout: Duration,
    pub url_prefix: String,
}

Configuration when sending a request using Client.

Should be returned by RequestHandler::request_config().

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

max_try: u8

Client will retry sending a request if it failed to send. max_try can be used limit the number of attempts.

Do not set this to 0 or Client::request() will panic. Defaults to 1 (which means no retry).

retry_cooldown: Duration

Duration that should elapse after retrying sending a request.

Defaults to 500ms. See also: max_try.

timeout: Duration

The timeout set when sending a request. Defaults to 3s.

It is possible for the RequestHandler to override this in RequestHandler::build_request(). See also: RequestBuilder::timeout().

url_prefix: String

The prefix which will be used for requests sent using this configuration. Defaults to "".

Example usage: "https://example.com"

Implementations

impl RequestConfig

pub fn new() -> Self

Constructs a new RequestConfig with its fields set to default.

Trait Implementations

impl Clone for RequestConfig

fn clone(&self) -> RequestConfig

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RequestConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for RequestConfig

fn default() -> Self

Returns the “default value” for a type.