Struct ClientConfigProfile 

#[non_exhaustive]
pub struct ClientConfigProfile {
    pub address: Option<String>,
    pub namespace: Option<String>,
    pub api_key: Option<String>,
    pub tls: Option<ClientConfigTLS>,
    pub codec: Option<ClientConfigCodec>,
    pub grpc_meta: HashMap<String, String>,
}

Available on crate feature envconfig only.

ClientConfigProfile is profile-level configuration for a client.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

address: Option<String>

Client address

namespace: Option<String>

Client namespace

api_key: Option<String>

Client API key. If present and TLS field is None or present and not disabled (i.e. without Disabled as true), TLS is defaulted to enabled.

tls: Option<ClientConfigTLS>

Optional client TLS config.

codec: Option<ClientConfigCodec>

Optional client codec config.

grpc_meta: HashMap<String, String>

Client gRPC metadata (aka headers). When loading from TOML and env var, or writing to TOML, the keys are lowercased and underscores are replaced with hyphens. This is used for deduplicating/overriding too, so manually set values that are not normalized may not get overridden when applying environment variables.

Implementations

impl ClientConfigProfile

pub fn builder() -> ClientConfigProfileBuilder

Create an instance of ClientConfigProfile using the builder syntax

impl ClientConfigProfile

pub fn load_from_env( &mut self, env_vars: Option<&HashMap<String, String>>, ) -> Result<(), ConfigError>

Apply environment variable overrides to this profile. If env_vars is None, the system’s environment variables will be used as the source.

Trait Implementations

impl Clone for ClientConfigProfile

fn clone(&self) -> ClientConfigProfile

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ClientConfigProfile

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

Formats the value using the given formatter.

impl Default for ClientConfigProfile

fn default() -> ClientConfigProfile

Returns the “default value” for a type.

impl PartialEq for ClientConfigProfile

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ClientConfigProfile

impl TryFrom<ClientConfigProfile> for ConnectionOptions

type Error = ConfigError

The type returned in the event of a conversion error.

fn try_from(profile: ClientConfigProfile) -> Result<Self, Self::Error>

Performs the conversion.