Struct TlsConfig 

#[non_exhaustive]
pub struct TlsConfig {
    pub ca_certificate_pem: Option<Vec<u8>>,
    pub domain_name: Option<String>,
    pub client_identity_pem: Option<(Vec<u8>, Vec<u8>)>,
}

TLS settings for the gRPC channel.

An empty TlsConfig (from TlsConfig::new) enables server-side TLS using the platform’s native root certificates. Add a custom CA for private/self- signed servers, a domain-name override for SNI/verification, and a client identity for mutual TLS. #[non_exhaustive].

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.

ca_certificate_pem: Option<Vec<u8>>

Custom CA certificate chain (PEM). When set, replaces the native roots (use for self-signed / private CAs).

domain_name: Option<String>

Domain name to verify the server certificate against (SNI). Defaults to the endpoint host.

client_identity_pem: Option<(Vec<u8>, Vec<u8>)>

Client identity (certificate_pem, private_key_pem) for mutual TLS.

Implementations

impl TlsConfig

pub fn new() -> TlsConfig

Server-side TLS using the platform’s native root certificates.

pub fn with_ca_certificate(self, ca_pem: impl Into<Vec<u8>>) -> TlsConfig

Trust this PEM CA certificate (chain) instead of the native roots.

pub fn with_domain_name(self, domain: impl Into<String>) -> TlsConfig

Override the domain name the server certificate is verified against.

pub fn with_client_identity( self, certificate_pem: impl Into<Vec<u8>>, private_key_pem: impl Into<Vec<u8>>, ) -> TlsConfig

Present a client identity (mutual TLS): (certificate_pem, key_pem).

Trait Implementations

impl Clone for TlsConfig

fn clone(&self) -> TlsConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TlsConfig

Hand-written so PEM bytes never reach a log. The derived Debug printed client_identity_pem in full, which is the mutual-TLS private key — one tracing field capturing a Config was enough to put it in a log aggregator. Presence and length are what a reader debugging a handshake actually needs.

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

Formats the value using the given formatter.

impl Default for TlsConfig

fn default() -> TlsConfig

Returns the “default value” for a type.