Struct Client 

pub struct Client { /* private fields */ }

The main Apollo configuration client.

This struct provides the primary interface for interacting with Apollo configuration services. It manages multiple namespace caches, handles background refresh tasks, and provides event listener functionality for real-time configuration updates.

Features

• Namespace Management: Automatically creates and manages caches for different namespaces
• Background Refresh: Optional background task that periodically refreshes all namespaces
• Event Listeners: Support for registering callbacks on configuration changes
• Cross-Platform: Works on both native Rust and WebAssembly targets
• Thread Safety: All operations are thread-safe and async-friendly

Examples

use apollo_rust_client::{Client, client_config::ClientConfig};

Implementations

impl Client

pub async fn add_listener(&self, namespace: &str, listener: EventListener)

pub async fn namespace(&self, namespace: &str) -> Result<Namespace, Error>

Retrieves a namespace configuration from the Apollo server.

This method fetches the configuration for the specified namespace and automatically detects the format based on the namespace name. The format detection follows these rules:

• Properties format (default): No file extension
• JSON format: .json extension
• YAML format: .yaml or .yml extension
• Text format: .txt extension
• XML format: .xml extension (not yet supported)

Arguments

• namespace - The namespace identifier string (e.g., “application”, “config.json”)

Returns

• Ok(Namespace) - The configuration data in the appropriate format
• Err(Error::Cache) - If cache operations fail (network, I/O, etc.)
• Err(Error::Namespace) - If namespace format detection or processing fails

Errors

This method will return an error if:

• Network requests to the Apollo server fail
• Cache file operations fail (native targets only)
• JSON parsing fails during configuration retrieval
• Namespace format detection fails
• The requested namespace format is not supported (e.g., XML)

Examples

use apollo_rust_client::{Client, client_config::ClientConfig};

pub async fn start(&mut self) -> Result<(), Error>

Starts a background task that periodically refreshes all registered namespace caches.

This method spawns an asynchronous task using async_std::task::spawn on native targets or wasm_bindgen_futures::spawn_local on wasm32 targets. The task loops indefinitely (until stop is called or the client is dropped) and performs the following actions in each iteration:

1. Iterates through all namespaces currently managed by the client.
2. Calls the refresh method on each namespace’s Cache instance.
3. Logs any errors encountered during the refresh process.
4. Sleeps for a predefined interval (currently 30 seconds) before the next refresh cycle.

Returns

• Ok(()) if the background task was successfully started.
• Err(Error::AlreadyRunning) if the background task is already active.

Errors

This method will return an error if:

• The background task is already running (Error::AlreadyRunning)
• Task spawning fails (though this is rare and typically indicates system resource issues)

pub async fn stop(&mut self)

Stops the background cache refresh task.

This method sets the running flag to false, signaling the background task to terminate its refresh loop.

On non-wasm32 targets, it also attempts to explicitly cancel the spawned task by calling cancel() on its JoinHandle if it exists. This helps to ensure that the task is properly cleaned up. On wasm32 targets, there is no direct handle to cancel, so setting the running flag is the primary mechanism for stopping.

impl Client

pub fn new(config: ClientConfig) -> Self

Create a new Apollo client.

Arguments

• client_config - The configuration for the Apollo client.

Returns

A new Apollo client.

Trait Implementations

impl From<Client> for JsValue

fn from(value: Client) -> Self

Converts to this type from the input type.

impl FromWasmAbi for Client

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 Client

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 Client

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RcRef<Client>

Same as RefFromWasmAbi::Anchor

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

Same as RefFromWasmAbi::ref_from_abi

impl OptionFromWasmAbi for Client

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 Client

fn none() -> Self::Abi

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

impl RefFromWasmAbi for Client

type Abi = u32

The Wasm ABI type references to Self are recovered from.

type Anchor = RcRef<Client>

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 Client

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RcRefMut<Client>

Same as RefFromWasmAbi::Anchor

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

Same as RefFromWasmAbi::ref_from_abi

impl TryFromJsValue for Client

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 Client

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

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

impl VectorIntoJsValue for Client

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

impl VectorIntoWasmAbi for Client

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

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

impl WasmDescribe for Client

fn describe()

impl WasmDescribeVector for Client

fn describe_vector()

impl SupportsConstructor for Client

impl SupportsInstanceProperty for Client

impl SupportsStaticProperty for Client