Struct matrix_sdk::config::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: u64) -> Self

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

pub fn timeout(self, timeout: Duration) -> Self

Set the timeout duration for all HTTP requests.

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

Set a timeout for how long a request should be retried. The default is no timeout, meaning requests are retried forever.

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 copy 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