Struct ClientConfig 

pub struct ClientConfig {

    pub endpoint: String,
    pub origin: Option<String>,
    pub server_name: Option<String>,
    pub compression: Option<CompressionType>,
    pub rate_limit: Option<String>,
    pub tls_setting: TlsClientConfig,
    pub keepalive: Option<KeepaliveConfig>,
    pub proxy: ProxyConfig,
    pub connect_timeout: DurationString,
    pub request_timeout: DurationString,
    pub buffer_size: Option<usize>,
    pub headers: HashMap<String, String>,
    pub auth: AuthenticationConfig,
    pub backoff: BackoffConfig,
    pub metadata: Option<MetadataMap>,
    pub link_id: String,
    pub require_header_mac: bool,
    pub connection_type: ConnType,
}

Struct for the client configuration. This struct contains the endpoint, origin, compression type, rate limit, TLS settings, keepalive settings, proxy settings, timeout settings, buffer size settings, headers, and auth settings. The client configuration can be converted to a transport channel via ClientConfig::to_channel.

Fields

endpoint: String

The target the client will connect to.

The transport protocol is inferred from the endpoint scheme:

• ws://, wss:// → WebSocket (TLS when wss)
• http://, https://, unix://, bare host:port → gRPC

origin: Option<String>

Origin (HTTP Host authority override) for the client.

server_name: Option<String>

Optional TLS SNI server name override. If set, this value is used for TLS server name verification (SNI) instead of the host extracted from endpoint/origin.

compression: Option<CompressionType>

Compression type - TODO(msardara): not implemented yet.

rate_limit: Option<String>

Rate Limits

tls_setting: TlsClientConfig

TLS client configuration.

keepalive: Option<KeepaliveConfig>

Keepalive parameters.

proxy: ProxyConfig

HTTP Proxy configuration.

connect_timeout: DurationString

Timeout for the connection.

request_timeout: DurationString

Timeout per request.

buffer_size: Option<usize>

ReadBufferSize.

headers: HashMap<String, String>

The headers associated with gRPC requests.

auth: AuthenticationConfig

Auth configuration for outgoing RPCs.

backoff: BackoffConfig

Backoff retry configuration.

metadata: Option<MetadataMap>

Arbitrary user-provided metadata.

link_id: String

Link identifier for this connection, used during link negotiation. Defaults to a randomly generated UUID v4.

require_header_mac: bool

Flag to enforce header integrity validation

connection_type: ConnType

The type of connection this client establishes. Defaults to edge. Set to peer for intra-deployment peer connections, or remote for control-plane-managed inter-deployment links.

Implementations

impl ClientConfig

pub fn with_endpoint(endpoint: &str) -> Self

Creates a new client configuration with the given endpoint. This function will return a ClientConfig with the endpoint set and all other fields set to default.

pub fn with_origin(self, origin: &str) -> Self

pub fn with_server_name(self, server_name: &str) -> Self

pub fn with_rate_limit(self, rate_limit: &str) -> Self

pub fn with_keepalive(self, keepalive: KeepaliveConfig) -> Self

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

pub fn with_request_timeout(self, request_timeout: Duration) -> Self

pub fn with_buffer_size(self, buffer_size: usize) -> Self

pub fn with_headers(self, headers: HashMap<String, String>) -> Self

pub fn with_connection_type(self, connection_type: ConnType) -> Self

pub fn resolved_transport(&self) -> TransportProtocol

Resolve the transport protocol for this configuration by inspecting the endpoint URI scheme. See TransportProtocol::from_endpoint.

impl ClientConfig

pub fn merge_server_requirements( &mut self, server: &ServerConnectionConfig, ) -> Result<(), TlsConfigError>

pub fn with_compression(self, compression: CompressionType) -> Self

pub fn with_tls_setting(self, tls_setting: TLSSetting) -> Self

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

pub fn with_auth(self, auth: AuthenticationConfig) -> Self

pub fn with_backoff(self, backoff: BackoffConfig) -> Self

pub fn with_metadata(self, metadata: MetadataMap) -> Self

pub async fn to_channel( &self, ) -> Result<TransportChannel<impl GrpcService<Body, Error: Into<StdError> + Send, ResponseBody: Body<Data = Bytes, Error: Into<StdError> + Send> + Send + 'static, Future: Send> + Send + Clone + 'static + use<>>, ConfigError>

Build a transport channel from this configuration. The returned TransportChannel variant matches self.transport.

This is the single public entry point callers should use; the transport-specific builders (to_grpc_channel / to_websocket_channel) are crate-private.

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 Configuration for ClientConfig

type Error = ConfigError

fn validate(&self) -> Result<(), Self::Error>

Validate the component configuration

impl Debug for ClientConfig

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

Formats the value using the given formatter.

impl Default for ClientConfig

Defaults for ClientConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ClientConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ClientConfig

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

Formats the value using the given formatter.

impl JsonSchema for ClientConfig

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for ClientConfig

fn eq(&self, other: &ClientConfig) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for ClientConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ClientConfig