Skip to main content

RedisBackendBuilder

Struct RedisBackendBuilder 

Source
pub struct RedisBackendBuilder { /* private fields */ }
Expand description

Builder for RedisBackend.

Implementations§

Source§

impl RedisBackendBuilder

Source

pub fn url(self, url: impl Into<String>) -> Self

Set the Redis connection URL (required).

Accepts standard Redis URL formats, e.g. redis://localhost:6379 or redis://:password@host:6379/0.

Source

pub fn auto_reconnect(self) -> Self

Automatically re-establish dropped connections with exponential backoff (100 ms → 30 s, retrying indefinitely). Off by default.

Also turns on fred’s unresponsive-connection check: a connection with a reply pending for longer than the command timeout is closed and re-established (fred checks every 2 s). Without a reconnect policy that check stays off, because a closed connection would never come back.

Initial connections still fail fast — fred’s fail_fast default stays on, so the policy only governs reconnecting a connection that was previously established. This is the policy CacheKit::production and CacheKit::secure use. Call it when you build a backend yourself, for example one backend shared by several clients through CacheKitBuilder::backend, so it recovers after a Redis restart instead of failing every operation.

use cachekit::backend::redis::RedisBackend;

let backend = RedisBackend::builder()
    .url("redis://localhost:6379")
    .auto_reconnect()
    .build()?;
let _connection = backend.connect().await?;
Source

pub fn command_timeout(self, timeout: Duration) -> Self

Deadline for each Redis command (default 5 s). A command past it fails with BackendErrorKind::Timeout, and may still run on the server.

The budget is per attempt. When the reliability stack wraps the backend (CacheKit::production, CacheKit::secure, or CacheKitBuilder::reliability), each retry gets a fresh budget, so with the default 3 attempts one operation can take about three budgets plus backoff before it errors. The stack sets no overall deadline for Redis. Each operation that ends in a timeout counts as one failure toward opening the circuit breaker, which a tokio::time::timeout around the call does not: a cancelled call records no outcome. With auto_reconnect the budget is also the unresponsive-connection threshold.

build rejects Duration::ZERO with CachekitError::Config; fred reads zero as “no timeout”.

Source

pub fn build(self) -> Result<RedisBackend, CachekitError>

Consume the builder and construct a RedisBackend.

§Errors

Returns an error if url was not provided or is not a valid Redis URL, or if the command timeout is zero. The connection itself is lazy — call RedisBackend::connect to establish it.

Trait Implementations§

Source§

impl Default for RedisBackendBuilder

Source§

fn default() -> Self

Returns the “default value” for a type. 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> 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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