Skip to main content

MemoryBackend

Struct MemoryBackend 

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

In-process backend keeping job state in a single Mutex<Vec<…>>. Drop-in replacement for the bundled Queue storage; suitable for tests and single-node deployments. Replace with a remote backend for multi-pod use.

Memory bound: the pending queue is capped at MemoryBackend::max_pending (None = unlimited, default). Configure via MemoryBackend::with_max_pending to protect against unbounded growth when producers outpace consumers.

Implementations§

Source§

impl MemoryBackend

Source

pub fn new() -> MemoryBackend

Source

pub fn with_max_pending(self, max: usize) -> MemoryBackend

Cap the pending vector at max jobs. Subsequent MemoryBackend::push calls that would exceed the cap return BackendError::Transport with the message queue full.

Use this to bound memory growth when a misconfigured retry loop or runaway producer would otherwise fill the heap.

Source§

impl MemoryBackend

Source

pub fn dead_letters(&self) -> Vec<(JobId, String, Vec<u8>, u32)>

Snapshot of dead-letter jobs.

Source

pub fn pending_count(&self) -> usize

Number of pending jobs across every queue.

Source

pub fn reserved_count(&self) -> usize

Number of currently reserved jobs.

Source

pub fn dedup_size(&self) -> usize

Number of active dedup keys. Useful for diagnostics — if this grows unboundedly your jobs are not reaching complete/dead_letter.

Source

pub fn purge_dedup_key(&self, key: &str) -> bool

Drop a single dedup key out of band. Returns true if the key was present. Use this when a long retry tail needs to be cut short and a fresh push (same key) should be allowed to enqueue immediately.

Trait Implementations§

Source§

impl Default for MemoryBackend

Source§

fn default() -> MemoryBackend

Returns the “default value” for a type. Read more
Source§

impl QueueBackend for MemoryBackend

Source§

fn push<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, queue: &'life1 str, payload: &'life2 [u8], opts: PushOptions, ) -> Pin<Box<dyn Future<Output = Result<JobId, BackendError>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, MemoryBackend: 'async_trait,

Push a payload onto a named queue, returning the job id.
Source§

fn reserve<'life0, 'life1, 'async_trait>( &'life0 self, queue: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<Option<ReservedJob>, BackendError>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, MemoryBackend: 'async_trait,

Reserve the next ready job from a queue (FIFO, ready_at <= now).
Source§

fn complete<'life0, 'async_trait>( &'life0 self, id: JobId, ) -> Pin<Box<dyn Future<Output = Result<(), BackendError>> + Send + 'async_trait>>
where 'life0: 'async_trait, MemoryBackend: 'async_trait,

Mark a reserved job complete — no retries, no DLQ entry.
Source§

fn fail<'life0, 'async_trait>( &'life0 self, id: JobId, retry_at: Option<Instant>, ) -> Pin<Box<dyn Future<Output = Result<(), BackendError>> + Send + 'async_trait>>
where 'life0: 'async_trait, MemoryBackend: 'async_trait,

Mark a reserved job failed; if retry_at is set, requeue for that time.
Source§

fn dead_letter<'life0, 'async_trait>( &'life0 self, id: JobId, ) -> Pin<Box<dyn Future<Output = Result<(), BackendError>> + Send + 'async_trait>>
where 'life0: 'async_trait, MemoryBackend: 'async_trait,

Move a job to the dead-letter queue (terminal failure).

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> FutureExt for T

Source§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
Source§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
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 = 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