Struct HttpConfig 

pub struct HttpConfig {
    pub url: String,
    pub authorization: Option<String>,
    pub base_timeout: Duration,
    pub modem_timeout: Option<Duration>,
}

HTTP-specific configuration.

Fields

url: String

HTTP base URL. eg: http://192.168.1.2:3000

authorization: Option<String>

Optional HTTP authorization header token.

base_timeout: Duration

A default timeout to apply to all requests that do not have their own timeout (this applies to all if modem_timeout is None, otherwise only database and sys queries).

modem_timeout: Option<Duration>

An optional timeout to use specifically for modem requests (requests that must send and receive modem data). This should be higher than the default timeout as they can take longer.

Implementations

impl HttpConfig

pub const HTTP_DEFAULT_BASE_TIMEOUT: u64 = 5u64

The default amount of seconds before an HTTP request should time out. If there is no modem_timeout, this is applied to all requests.

pub const HTTP_DEFAULT_MODEM_TIMEOUT: u64 = 20u64

The default amount of seconds before an HTTP request that interacts directly with the modem should time out. This should be longer to allow for carrier response.

pub fn new(url: impl Into<String>) -> Self

Create a new HTTP configuration with default settings.

pub fn with_auth(self, token: impl Into<String>) -> Self

Set the authorization token.

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

Set the base request timeout.

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

Set the modem request timeout.

Trait Implementations

impl Clone for HttpConfig

fn clone(&self) -> HttpConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HttpConfig

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

Formats the value using the given formatter.

impl Default for HttpConfig

fn default() -> Self

Returns the “default value” for a type.

impl From<HttpConfig> for ClientConfig

fn from(http: HttpConfig) -> Self

Converts to this type from the input type.