Skip to main content

ValkeyConfig

Struct ValkeyConfig 

Source
pub struct ValkeyConfig {
    pub endpoint: String,
    pub tls: bool,
    pub username: Option<String>,
    pub password: Option<String>,
    pub key_prefix: String,
    pub ttl_seconds: Option<u64>,
    pub max_session_lifetime_seconds: Option<u64>,
    pub connect_timeout_ms: u64,
    pub command_timeout_ms: u64,
}
Expand description

Parsed global.apl.session_store config for kind: valkey.

Unknown keys (including kind, consumed by the factory dispatch) are ignored so the same block can carry the discriminator.

Fields§

§endpoint: String

Endpoint: a redis:// / rediss:// URL or a bare host:port.

§tls: bool

Whether to use TLS. Implied true for a rediss:// endpoint. Required for any non-localhost endpoint (validated).

§username: Option<String>

Optional ACL username (Valkey 6+ ACLs). Paired with password.

§password: Option<String>

Optional auth password / ACL secret. Sourced from config/env by the operator; never hard-coded.

§key_prefix: String

Key prefix/namespace for label keys (R9).

§ttl_seconds: Option<u64>

Sliding TTL in seconds, refreshed on load and append. None (default) means no expiry (R7).

§max_session_lifetime_seconds: Option<u64>

Declared maximum session-identity lifetime, used only to emit the TTL-soundness warning (R17) when ttl_seconds is shorter.

§connect_timeout_ms: u64

Connection acquisition timeout (ms).

§command_timeout_ms: u64

Per-command response timeout (ms) — the fail-closed hot-path knob.

Implementations§

Source§

impl ValkeyConfig

Source

pub fn from_value(value: &Value) -> Result<Self, BuildError>

Parse from the YAML config block, then validate.

Source

pub fn tls_enabled(&self) -> bool

TLS is on when explicitly set or implied by a rediss:// scheme.

Source

pub fn connection_url(&self) -> Result<String, BuildError>

Build the redis/rediss connection URL deadpool consumes.

Credentials are percent-encoded via the url crate (never naive string interpolation), and the wire scheme always reflects Self::tls_enabled so it cannot disagree with the validated TLS intent. A fully-formed endpoint URL is parsed (and trusted for its own embedded credentials); a bare host:port is assembled with the configured scheme and any separate username/password.

Trait Implementations§

Source§

impl Clone for ValkeyConfig

Source§

fn clone(&self) -> ValkeyConfig

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ValkeyConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for ValkeyConfig

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more