Struct ValkeyConfig 

pub struct ValkeyConfig { /* private fields */ }

Validated Valkey client configuration.

Implementations

impl ValkeyConfig

pub fn new(input: ValkeyConfigInput) -> ValkeyResult<Self>

Validates and constructs Valkey configuration.

pub fn from_env_prefix(prefix: &str) -> ValkeyResult<Self>

Builds configuration from process environment variables using a prefix.

For prefix = "EXAMPLE_SEARCH", this reads the required EXAMPLE_SEARCH_VALKEY_HOST and optional VALKEY_PORT, VALKEY_DATABASE, VALKEY_USERNAME, VALKEY_PASSWORD, VALKEY_KEY_PREFIX, VALKEY_TLS_MODE, and bounded connection-manager policy variables with the same prefix. TLS defaults to required and plaintext requires the exact allow-plaintext-development value.

pub fn host(&self) -> &str

Returns the server hostname or IP address.

pub const fn port(&self) -> u16

Returns the server TCP port.

pub const fn database(&self) -> u32

Returns the logical database number.

pub const fn username(&self) -> Option<&SecretString>

Returns the optional ACL username.

pub const fn password(&self) -> Option<&SecretString>

Returns the optional password or access token.

pub fn key_prefix(&self) -> &str

Returns the key namespace prefix.

pub const fn transport_security(&self) -> ValkeyTransportSecurity

Returns the transport security policy.

pub const fn tls_trust(&self) -> &ValkeyTlsTrust

Returns the certificate trust policy used for TLS connections.

pub const fn connection_timeout(&self) -> Duration

Returns the connection establishment deadline.

pub const fn response_timeout(&self) -> Duration

Returns the command response deadline.

pub const fn retry_attempts(&self) -> u32

Returns automatic reconnect attempts.

pub const fn concurrency_limit(&self) -> u32

Returns the in-flight command ceiling.

pub const fn pipeline_buffer_size(&self) -> u32

Returns the outbound pipeline queue bound.

Trait Implementations

impl Debug for ValkeyConfig

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

Formats the value using the given formatter.