Struct wasmcloud_control_interface::ClientBuilder

pub struct ClientBuilder<T> { /* private fields */ }

A client builder that can be used to fluently provide configuration settings used to construct the control interface client

Implementations

impl ClientBuilder<DirectKvStore>

pub fn new(nc: Client) -> ClientBuilder<DirectKvStore>

Creates a new client builder using the given client

impl<T> ClientBuilder<T>

pub fn topic_prefix(self, prefix: impl Into<String>) -> ClientBuilder<T>

Sets the topic prefix for the NATS topic used for all control requests. Not to be confused with lattice ID/prefix

pub fn lattice_prefix(self, prefix: impl Into<String>) -> ClientBuilder<T>

The lattice ID/prefix used for this client. If this function is not invoked, the prefix will be set to default

pub fn rpc_timeout(self, timeout: Duration) -> ClientBuilder<T>

Sets the timeout for standard calls and RPC invocations used by the client. If not set, the default will be 2 seconds

pub fn auction_timeout(self, timeout: Duration) -> ClientBuilder<T>

Sets the timeout for auction (scatter/gather) operations. If not set, the default will be 5 seconds

pub fn js_domain(self, domain: impl Into<String>) -> ClientBuilder<T>

Sets the JetStream domain for this client, which can be critical for locating the right key-value bucket for lattice metadata storage. If this is skipped, then the JS domain will be None

pub fn use_caching(self) -> ClientBuilder<CachedKvStore>

Tells the client to use caching for lattice metadata. This is useful for long running applications that want to consistently fetch lattice metadata. If this is not set, then every call to get_links or get_claims will result in a query to the lattice metadata bucket

impl ClientBuilder<CachedKvStore>

pub async fn build( self ) -> Result<Client<CachedKvStore>, Box<dyn Error + Send + Sync>>

Completes the generation of a control interface client. This function is async because it will attempt to locate and attach to a metadata key-value bucket (LATTICEDATA_{prefix}) when starting. If this bucket is not discovered during build time, all subsequent client calls will operate in “legacy” mode against the deprecated control interface topics

impl ClientBuilder<DirectKvStore>

pub async fn build( self ) -> Result<Client<DirectKvStore>, Box<dyn Error + Send + Sync>>

Completes the generation of a control interface client. This function is async because it will attempt to locate and attach to a metadata key-value bucket (LATTICEDATA_{prefix}) when starting. If this bucket is not discovered during build time, all subsequent client calls will operate in “legacy” mode against the deprecated control interface topics

Trait Implementations

impl Default for ClientBuilder<DirectKvStore>

fn default() -> Self

Returns the “default value” for a type.