Skip to main content

ClientTracking

Struct ClientTracking 

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

CLIENT TRACKING ON|OFF [REDIRECT client-id] [PREFIX prefix] [BCAST] [OPTIN] [OPTOUT] [NOLOOP]

Enable or disable server-assisted client-side caching.

Implementations§

Source§

impl ClientTracking

Source

pub fn on() -> ClientTracking

Enable client tracking.

Source

pub fn off() -> ClientTracking

Disable client tracking.

Source

pub fn redirect(self, client_id: i64) -> ClientTracking

Redirect invalidation messages to another connection’s client ID.

The ID can be obtained with ClientId. Redirecting is useful when a dedicated RESP3 connection owns the invalidation push stream while a separate connection executes data commands.

Source

pub fn bcast(self) -> ClientTracking

Enable broadcasting mode (invalidate all keys matching prefixes).

Source

pub fn prefix(self, prefix: impl AsRef<[u8]>) -> ClientTracking

Add a binary-safe key prefix to track and enable BCAST mode.

Source

pub fn optin(self) -> ClientTracking

Enable opt-in mode (only track keys after CLIENT CACHING YES).

Source

pub fn optout(self) -> ClientTracking

Enable opt-out mode (track all keys, skip after CLIENT CACHING NO).

Source

pub fn noloop(self) -> ClientTracking

Suppress invalidations caused by writes on the tracked connection.

Cached clients must pair this with synchronous local write invalidation so their own writes cannot leave stale entries behind.

Trait Implementations§

Source§

impl Clone for ClientTracking

Source§

fn clone(&self) -> ClientTracking

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 Command for ClientTracking

Source§

type Response = ()

The typed response this command produces.
Source§

fn to_frame(&self) -> Frame

Serialize this command into a RESP frame for the wire.
Source§

fn parse_response( &self, frame: Frame, ) -> Result<<ClientTracking as Command>::Response, RedisError>

Parse a RESP response frame into the typed response. Read more
Source§

fn name(&self) -> &str

The Redis command name, for observability (metrics, tracing spans).
Source§

fn idempotent(&self) -> bool

Whether this command is safe to retry on connection errors. Read more
Source§

fn is_blocking(&self) -> bool

Whether this command blocks the connection until data is available or a timeout elapses – BLPOP, BRPOP, BLMOVE, BZPOPMIN/BZPOPMAX, and XREAD/XREADGROUP with BLOCK. Read more
Source§

fn deadline(&self) -> Option<Instant>

Return the absolute deadline attached to this command, if any. 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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> 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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<C> RequestDeadline for C
where C: Command,

Source§

fn request_deadline(&self) -> Option<Instant>

Return the request’s absolute deadline, if it carries one.
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 = !

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