Struct ClientOptions 

pub struct ClientOptions {
    pub app_id: String,
    pub secret: String,
    pub nodes: Vec<String>,
    pub env: String,
    pub name: Option<String>,
    pub tag: Option<String>,
    pub http_timeout: Duration,
    pub reconnect_interval: Duration,
    pub heartbeat_interval: Duration,
    pub cache: CacheOptions,
}

Connection and cache settings for Client.

Fields are public so callers can construct this struct directly. Invalid combinations (empty app_id or nodes) are rejected by Client::new.

Examples

use agile_config_client::ClientOptions;

let options = ClientOptions {
    app_id: "app".into(),
    secret: "secret".into(),
    nodes: vec!["http://localhost:5000".into()],
    env: "DEV".into(),
    ..ClientOptions::default()
};
assert_eq!(options.app_id, "app");

Fields

app_id: String

Application id configured in the AgileConfig console.

secret: String

Application secret. May be empty when the app has no secret.

nodes: Vec<String>

Server node base URLs (http:// or https://).

Entries may be comma-separated; they are split and trimmed in Client::new.

env: String

Target environment. Empty lets the server pick its default.

name: Option<String>

Optional display name shown in the admin console.

tag: Option<String>

Optional tag shown in the admin console.

http_timeout: Duration

Timeout for HTTP configuration pulls.

reconnect_interval: Duration

Delay between WebSocket reconnect attempts.

heartbeat_interval: Duration

Interval for sending WebSocket ping text frames.

cache: CacheOptions

Local file cache settings.

Implementations

impl ClientOptions

pub fn builder() -> ClientBuilder

Starts a builder that fills a ClientOptions value.

Trait Implementations

impl Clone for ClientOptions

fn clone(&self) -> ClientOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ClientOptions

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

Formats the value using the given formatter.

impl Default for ClientOptions

fn default() -> Self

Returns the “default value” for a type.