Skip to main content

RateLimitedQueue

Struct RateLimitedQueue 

Source
pub struct RateLimitedQueue<Q: ?Sized> { /* private fields */ }
Expand description

A queue decorator that enforces a rate limit on enqueue.

Implementations§

Source§

impl<Q: Queue + 'static> RateLimitedQueue<Q>

Source

pub fn new(inner: Q, rate_per_sec: f64, burst: u32) -> Self

Creates a new rate-limited wrapper around inner.

Trait Implementations§

Source§

impl<Q: Queue + ?Sized> Queue for RateLimitedQueue<Q>

Source§

fn enqueue<'life0, 'life1, 'async_trait>( &'life0 self, topic: &'life1 str, payload: Vec<u8>, ) -> Pin<Box<dyn Future<Output = Result<(), QueueError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Enqueues payload onto topic.
Source§

fn dequeue<'life0, 'life1, 'async_trait>( &'life0 self, topic: &'life1 str, timeout: Duration, ) -> Pin<Box<dyn Future<Output = Result<Option<Job>, QueueError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Dequeues the next job from topic, waiting up to timeout. Read more
Source§

fn ack<'life0, 'life1, 'async_trait>( &'life0 self, job: &'life1 Job, ) -> Pin<Box<dyn Future<Output = Result<(), JobError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Acknowledges a job as successfully processed.
Source§

fn nack<'life0, 'life1, 'async_trait>( &'life0 self, job: &'life1 Job, requeue: bool, ) -> Pin<Box<dyn Future<Output = Result<(), JobError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Negative-acknowledges a job. If requeue is true the job goes back onto the queue; if false it moves to the dead-letter queue (if configured).
Source§

fn dlq_move<'life0, 'life1, 'async_trait>( &'life0 self, topic: &'life1 str, job: Job, ) -> Pin<Box<dyn Future<Output = Result<(), QueueError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Moves a job to the dead-letter queue for topic.
Source§

fn len<'life0, 'life1, 'async_trait>( &'life0 self, topic: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<u64, QueueError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Number of messages currently waiting in topic.
Source§

fn is_empty<'life0, 'life1, 'async_trait>( &'life0 self, topic: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<bool, QueueError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Whether the queue is empty.

Auto Trait Implementations§

§

impl<Q> !RefUnwindSafe for RateLimitedQueue<Q>

§

impl<Q> !UnwindSafe for RateLimitedQueue<Q>

§

impl<Q> Freeze for RateLimitedQueue<Q>
where Arc<Q>: Freeze, Q: ?Sized,

§

impl<Q> Send for RateLimitedQueue<Q>
where Arc<Q>: Send, Q: ?Sized,

§

impl<Q> Sync for RateLimitedQueue<Q>
where Arc<Q>: Sync, Q: ?Sized,

§

impl<Q> Unpin for RateLimitedQueue<Q>
where Arc<Q>: Unpin, Q: ?Sized,

§

impl<Q> UnsafeUnpin for RateLimitedQueue<Q>
where Arc<Q>: UnsafeUnpin, Q: ?Sized,

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