Skip to main content

RedisQueueLayer

Struct RedisQueueLayer 

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

Redis ZSET layer for queued runs ({prefix}:ready:{pool} or hash-tagged for cluster).

Used only as the claim hot path inside crate::PostgresRedisSchedulerStore — not a standalone SchedulerStore. Connect with Self::connect:

KnobEffect
url / CHRONON_REDIS_URLStandalone Redis
CHRONON_REDIS_CLUSTER_URLSComma-separated cluster nodes
CHRONON_REDIS_HASH_TAGS=1Hash-tagged pool keys for slot affinity
key_prefix (default chronon)Key namespace

§Examples

use chronon_backend_redis::RedisQueueLayer;

let redis = RedisQueueLayer::connect("redis://127.0.0.1:6379", Some("myapp")).await?;

Implementations§

Source§

impl RedisQueueLayer

Source

pub async fn connect( url: &str, key_prefix: Option<&str>, ) -> Result<RedisQueueLayer, ChrononError>

Connect to Redis at url with optional key prefix (default chronon).

When CHRONON_REDIS_CLUSTER_URLS is set (comma-separated), uses Redis Cluster. When CHRONON_REDIS_HASH_TAGS=1, pool keys use hash tags for cluster slot affinity.

§Errors

Returns a storage error when the connection cannot be established.

Source

pub fn test_url() -> String

Redis URL for tests (CHRONON_TEST_REDIS_URL, then CHRONON_REDIS_URL, or local default).

Source

pub async fn enqueue_run( &self, pool_id: &str, run_id: &str, scheduled_for: DateTime<Utc>, ) -> Result<(), ChrononError>

Enqueue a run id ordered by scheduled_for (ZADD score = epoch millis).

§Errors

Returns a storage error when Redis commands fail.

Source

pub async fn claim_next_run_id( &self, pool_id: &str, now: DateTime<Utc>, ) -> Result<Option<String>, ChrononError>

Atomically pop the earliest due run id (score <= now) from the pool queue.

§Errors

Returns a storage error when Redis commands fail.

Source

pub async fn claim_next_run_ids( &self, pool_id: &str, count: usize, now: DateTime<Utc>, ) -> Result<Vec<String>, ChrononError>

Pop up to count earliest due run ids (scheduled_for score ≤ now).

§Errors

Returns a storage error when Redis commands fail.

Source

pub async fn remove_run( &self, pool_id: &str, run_id: &str, ) -> Result<(), ChrononError>

Remove a run from the ready queue (e.g. after cancellation).

§Errors

Returns a storage error when Redis commands fail.

Source

pub async fn flush_keys(&self) -> Result<(), ChrononError>

Delete all keys with this layer’s prefix (test isolation).

§Errors

Returns a storage error when Redis commands fail.

Trait Implementations§

Source§

impl Debug for RedisQueueLayer

Source§

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

Formats the value using the given formatter. 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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,

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

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 = 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<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