Struct RequestConfig

pub struct RequestConfig { /* private fields */ }

Configuration for requests the Client makes.

This sets how often and for how long a request should be repeated. As well as how long a successful request is allowed to take.

By default requests are retried indefinitely and use no timeout.

Examples

use matrix_sdk::config::RequestConfig;
use std::time::Duration;

// This sets makes requests fail after a single send request and sets the timeout to 30s
let request_config = RequestConfig::new()
    .disable_retry()
    .timeout(Duration::from_secs(30));

Implementations

impl RequestConfig

pub fn new() -> Self

Create a new default RequestConfig.

pub fn short_retry() -> Self

Create a new RequestConfig with default values, except the retry limit which is set to 3.

pub fn disable_retry(self) -> Self

This is a convince method to disable the retries of a request. Setting the retry_limit to 0 has the same effect.

pub fn retry_limit(self, retry_limit: usize) -> Self

The number of times a request should be retried. The default is no limit.

pub fn max_concurrent_requests(self, limit: Option<NonZeroUsize>) -> Self

The total limit of request that are pending or run concurrently. Any additional request beyond that number will be waiting until another concurrent requests finished. Requests are queued fairly.

pub fn timeout(self, timeout: impl Into<Option<Duration>>) -> Self

Set the timeout duration for all HTTP requests.

pub fn read_timeout(self, timeout: impl Into<Option<Duration>>) -> Self

Set the read timeout duration for all HTTP requests.

The timeout applies to each read operation, and resets after a successful read. This is more appropriate for detecting stalled connections when the size isn’t known beforehand.

IMPORTANT: note this value can only be applied when the HTTP client is instantiated, it won’t have any effect on a per-request basis.

pub fn max_retry_time(self, retry_timeout: Duration) -> Self

Set a time limit for how long a request should be retried. The default is that there isn’t a limit, meaning requests are retried forever.

This is a time-based variant of the RequestConfig::retry_limit method.

pub fn force_auth(self) -> Self

Force sending authorization even if the endpoint does not require it. Default is only sending authorization if it is required.

Trait Implementations

impl Clone for RequestConfig

fn clone(&self) -> RequestConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RequestConfig

Available on non-tarpaulin_include only.

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

Formats the value using the given formatter.

impl Default for RequestConfig

fn default() -> Self

Returns the “default value” for a type.

impl Copy for RequestConfig