Struct Builder 

pub struct Builder<T = Complete>(/* private fields */);

A builder to construct Clients and blocking::Clients.

Implementations

impl Builder<ServiceStage>

pub fn new() -> Self

Creates a new builder with default settings.

pub fn service(self, service: &str) -> Builder<UserAgentStage>

Sets the name of the service this client will communicate with.

This is used in logging and metrics to allow differentiation between different clients.

impl Builder<UserAgentStage>

pub fn user_agent(self, user_agent: UserAgent) -> Builder

Sets the user agent sent by this client.

impl Builder<Complete>

pub fn from_config(self, config: &ServiceConfig) -> Self

Applies configuration settings from a ServiceConfig to the builder.

pub fn get_service(&self) -> &str

Returns the builder’s configured service name.

pub fn get_user_agent(&self) -> &UserAgent

Returns the builder’s configured user agent.

pub fn uri(self, uri: Url) -> Self

Appends a URI to the URIs list.

Defaults to an empty list.

pub fn uris(self, uris: Vec<Url>) -> Self

Sets the URIs list.

Defaults to an empty list.

pub fn get_uris(&self) -> &[Url]

Returns the builder’s configured URIs list.

pub fn security(self, security: SecurityConfig) -> Self

Sets the security configuration.

Defaults to an empty configuration.

pub fn get_security(&self) -> &SecurityConfig

Returns the builder’s configured security configuration.

pub fn proxy(self, proxy: ProxyConfig) -> Self

Sets the proxy configuration.

Defaults to ProxyConfig::Direct (i.e. no proxy).

pub fn get_proxy(&self) -> &ProxyConfig

Returns the builder’s configured proxy configuration.

pub fn connect_timeout(self, connect_timeout: Duration) -> Self

Sets the connect timeout.

Defaults to 10 seconds.

pub fn get_connect_timeout(&self) -> Duration

Returns the builder’s configured connect timeout.

pub fn read_timeout(self, read_timeout: Duration) -> Self

Sets the read timeout.

This timeout applies to socket-level read attempts.

Defaults to 5 minutes.

pub fn get_read_timeout(&self) -> Duration

Returns the builder’s configured read timeout.

pub fn write_timeout(self, write_timeout: Duration) -> Self

Sets the write timeout.

This timeout applies to socket-level write attempts.

Defaults to 5 minutes.

pub fn get_write_timeout(&self) -> Duration

Returns the builder’s configured write timeout.

pub fn backoff_slot_size(self, backoff_slot_size: Duration) -> Self

Sets the backoff slot size.

This is the upper bound on the initial delay before retrying a request. It grows exponentially as additional attempts are made for a given request.

Defaults to 250 milliseconds.

pub fn get_backoff_slot_size(&self) -> Duration

Returns the builder’s configured backoff slot size.

pub fn max_num_retries(self, max_num_retries: u32) -> Self

Sets the maximum number of times a request attempt will be retried before giving up.

Defaults to 4.

pub fn get_max_num_retries(&self) -> u32

Returns the builder’s configured maximum number of retries.

pub fn client_qos(self, client_qos: ClientQos) -> Self

Sets the client’s internal rate limiting behavior.

Defaults to ClientQos::Enabled.

pub fn get_client_qos(&self) -> ClientQos

Returns the builder’s configured internal rate limiting behavior.

pub fn server_qos(self, server_qos: ServerQos) -> Self

Sets the client’s behavior in response to a QoS error from the server.

Defaults to ServerQos::AutomaticRetry.

pub fn get_server_qos(&self) -> ServerQos

Returns the builder’s configured server QoS behavior.

pub fn service_error(self, service_error: ServiceError) -> Self

Sets the client’s behavior in response to a service error from the server.

Defaults to ServiceError::WrapInNewError.

pub fn get_service_error(&self) -> ServiceError

Returns the builder’s configured service error handling behavior.

pub fn idempotency(self, idempotency: Idempotency) -> Self

Sets the client’s behavior to determine if a request is idempotent or not.

Only idempotent requests will be retried.

Defaults to Idempotency::ByMethod.

pub fn get_idempotency(&self) -> Idempotency

Returns the builder’s configured idempotency handling behavior.

pub fn node_selection_strategy( self, node_selection_strategy: NodeSelectionStrategy, ) -> Self

Sets the client’s strategy for selecting a node for a request.

Defaults to NodeSelectionStrategy::PinUntilError.

pub fn get_node_selection_strategy(&self) -> NodeSelectionStrategy

Returns the builder’s configured node selection strategy.

pub fn metrics(self, metrics: Arc<MetricRegistry>) -> Self

Sets the metric registry used to register client metrics.

Defaults to no registry.

pub fn get_metrics(&self) -> Option<&Arc<MetricRegistry>>

Returns the builder’s configured metric registry.

pub fn host_metrics(self, host_metrics: Arc<HostMetricsRegistry>) -> Self

Sets the host metrics registry used to track host performance.

Defaults to no registry.

pub fn get_host_metrics(&self) -> Option<&Arc<HostMetricsRegistry>>

Returns the builder’s configured host metrics registry.

pub fn override_host_index(self, override_host_index: usize) -> Self

Overrides the hostIndex field included in metrics.

pub fn get_override_host_index(&self) -> Option<usize>

Returns the builder’s hostIndex override.

pub fn build(&self) -> Result<Client, Error>

Creates a new Client.

impl Builder<Complete>

pub fn blocking_handle(self, blocking_handle: Handle) -> Self

Returns the Handle to the tokio Runtime to be used by blocking clients.

This has no effect on async clients.

Defaults to a conjure-runtime internal Runtime.

pub fn get_blocking_handle(&self) -> Option<&Handle>

Returns the builder’s configured blocking handle.

pub fn build_blocking(&self) -> Result<Client, Error>

Creates a new blocking::Client.

Trait Implementations

impl Default for Builder<ServiceStage>

fn default() -> Self

Returns the “default value” for a type.