Struct ClientConfig

pub struct ClientConfig {
    pub app_id: String,
    pub cluster: String,
    pub cache_dir: Option<String>,
    pub config_server: String,
    pub secret: Option<String>,
    pub label: Option<String>,
    pub ip: Option<String>,
    pub cache_ttl: Option<u64>,
}

Configuration settings for the Apollo client.

This struct contains all the necessary information to connect to and interact with an Apollo Configuration Center. It supports various configuration options including authentication, caching, and grayscale release targeting.

Required Fields

• app_id: Your application identifier in Apollo
• config_server: The Apollo configuration server URL
• cluster: The cluster name (typically “default”)

Optional Fields

• secret: Authentication secret key for secure access
• cache_dir: Local cache directory (native targets only)
• label: Labels for grayscale release targeting
• ip: IP address for grayscale release targeting

Examples

Minimal Configuration

use apollo_rust_client::client_config::ClientConfig;

let config = ClientConfig {
    app_id: "my-app".to_string(),
    config_server: "http://apollo-server:8080".to_string(),
    cluster: "default".to_string(),
    secret: None,
    cache_dir: None,
    label: None,
    ip: None,
    #[cfg(not(target_arch = "wasm32"))]
    cache_ttl: None,
};

Full Configuration

use apollo_rust_client::client_config::ClientConfig;

let config = ClientConfig {
    app_id: "my-app".to_string(),
    config_server: "http://apollo-server:8080".to_string(),
    cluster: "production".to_string(),
    secret: Some("secret-key".to_string()),
    cache_dir: Some("/custom/cache/path".to_string()),
    label: Some("canary,beta".to_string()),
    ip: Some("192.168.1.100".to_string()),
    #[cfg(not(target_arch = "wasm32"))]
    cache_ttl: None,
};

Fields

app_id: String

The unique identifier for your application in Apollo.

This is used to identify which application’s configuration to retrieve from the Apollo Configuration Center.

cluster: String

The cluster name to connect to.

Clusters allow you to organize different environments or deployment groups. Common values include “default”, “production”, “staging”, etc.

cache_dir: Option<String>

The directory to store local cache files (native targets only).

On native Rust targets, this specifies where configuration files should be cached locally. If None, defaults to /opt/data/{app_id}/config-cache. On WebAssembly targets, this is always None as file system access is not available.

config_server: String

The Apollo configuration server URL.

This should be the base URL of your Apollo Configuration Center server, including the protocol (http/https) and port if necessary. Example: “http://apollo-server:8080”

secret: Option<String>

Optional secret key for authentication with the Apollo server.

If your Apollo namespace requires authentication, provide the secret key here. This is used to generate HMAC-SHA1 signatures for secure access to protected configuration namespaces.

label: Option<String>

Labels for grayscale release targeting.

Comma-separated list of labels that identify this client instance. Apollo can use these labels to determine which configuration version to serve during grayscale releases. Example: “canary,beta”

ip: Option<String>

IP address for grayscale release targeting.

The IP address of this client instance. Apollo can use this IP address to determine which configuration version to serve during grayscale releases based on IP-based targeting rules.

cache_ttl: Option<u64>

Time-to-live for the cache, in seconds (native targets only).

When using from_env, this defaults to 600 seconds (10 minutes) if the APOLLO_CACHE_TTL environment variable is not set. This field is not available on WebAssembly targets as disk caching is not supported.

Implementations

impl ClientConfig

pub fn from_env() -> Result<Self, Error>

Create a new configuration from environment variables.

Returns

A new configuration instance.

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 From<ClientConfig> for JsValue

fn from(value: ClientConfig) -> Self

Converts to this type from the input type.

impl FromWasmAbi for ClientConfig

type Abi = u32

The Wasm ABI type that this converts from when coming back out from the ABI boundary.

unsafe fn from_abi(js: u32) -> Self

Recover a Self from Self::Abi.

impl IntoWasmAbi for ClientConfig

type Abi = u32

The Wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self) -> u32

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl LongRefFromWasmAbi for ClientConfig

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RcRef<ClientConfig>

Same as RefFromWasmAbi::Anchor

unsafe fn long_ref_from_abi(js: Self::Abi) -> Self::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl OptionFromWasmAbi for ClientConfig

fn is_none(abi: &Self::Abi) -> bool

Tests whether the argument is a “none” instance. If so it will be deserialized as None, and otherwise it will be passed to FromWasmAbi.

impl OptionIntoWasmAbi for ClientConfig

fn none() -> Self::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option.

impl RefFromWasmAbi for ClientConfig

type Abi = u32

The Wasm ABI type references to Self are recovered from.

type Anchor = RcRef<ClientConfig>

The type that holds the reference to Self for the duration of the invocation of the function that has an &Self parameter. This is required to ensure that the lifetimes don’t persist beyond one function call, and so that they remain anonymous.

unsafe fn ref_from_abi(js: Self::Abi) -> Self::Anchor

Recover a Self::Anchor from Self::Abi.

impl RefMutFromWasmAbi for ClientConfig

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RcRefMut<ClientConfig>

Same as RefFromWasmAbi::Anchor

unsafe fn ref_mut_from_abi(js: Self::Abi) -> Self::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl TryFromJsValue for ClientConfig

type Error = JsValue

The type returned in the event of a conversion error.

fn try_from_js_value(value: JsValue) -> Result<Self, Self::Error>

Performs the conversion.

impl VectorFromWasmAbi for ClientConfig

type Abi = <Box<[JsValue]> as FromWasmAbi>::Abi

unsafe fn vector_from_abi(js: Self::Abi) -> Box<[ClientConfig]>

impl VectorIntoJsValue for ClientConfig

fn vector_into_jsvalue(vector: Box<[ClientConfig]>) -> JsValue

impl VectorIntoWasmAbi for ClientConfig

type Abi = <Box<[JsValue]> as IntoWasmAbi>::Abi

fn vector_into_abi(vector: Box<[ClientConfig]>) -> Self::Abi

impl WasmDescribe for ClientConfig

fn describe()

impl WasmDescribeVector for ClientConfig

fn describe_vector()

impl SupportsConstructor for ClientConfig

impl SupportsInstanceProperty for ClientConfig

impl SupportsStaticProperty for ClientConfig