Struct ClientConfig 

pub struct ClientConfig {
    pub tls: Option<TLSConfig>,
    pub http: Option<HttpConfig>,
}

Complete client configuration.

Fields

tls: Option<TLSConfig>

TLS configuration, used for both HTTP and WebSocket connections.

http: Option<HttpConfig>

HTTP configuration.

Implementations

impl ClientConfig

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

Create a new configuration with only HTTP support.

Example

use sms_client::config::ClientConfig;

let config = ClientConfig::http_only("http://192.168.1.2:3000");

pub fn add_tls(self, tls: TLSConfig) -> Self

Add TLS configuration.

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

Set authorization for both HTTP and WebSocket. This only sets the authorization value for components that already exist.

Example

use sms_client::config::ClientConfig;

let config = ClientConfig::both(
    "http://192.168.1.2:3000",
    "ws://192.168.1.2:3000/ws"
).with_auth("my-token");

pub fn with_certificate( self, certificate: impl Into<PathBuf>, ) -> ClientResult<Self>

Modify/Set a TLSConfig with certificate filepath.

Example

use sms_client::config::ClientConfig;

let config = ClientConfig::http_only("https://192.168.1.2:3000")
    .with_certificate("./certificate.crt")?;

pub fn configure_http<F>(self, f: F) -> Self

where F: FnOnce(HttpConfig) -> HttpConfig,

Configure the HTTP component if present.

Example

use sms_client::config::ClientConfig;
use std::time::Duration;

let config = ClientConfig::http_only("http://192.168.1.2:3000")
    .configure_http(|http| {
        http.with_base_timeout(Duration::from_secs(30))
            .with_auth("token")
    });

Trait Implementations

impl Clone for ClientConfig

fn clone(&self) -> ClientConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ClientConfig

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

Formats the value using the given formatter.

impl Default for ClientConfig

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.