Skip to main content

FsRequestQueue

Struct FsRequestQueue 

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

A durable FIFO request queue backed by atomic file replacements.

Request files, rather than state.json, are the source of truth. Leases are deliberately process-local, so requests leased by a process that exits are pending again when a new client rescans the queue. Writes use a temporary file and same-directory rename, but do not call fsync; a machine-level power loss can therefore lose writes that the operating system had not yet flushed.

Trait Implementations§

Source§

impl Debug for FsRequestQueue

Source§

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

Formats the value using the given formatter. Read more
Source§

impl RequestQueue for FsRequestQueue

Source§

fn add<'life0, 'async_trait>( &'life0 self, request: Request, opts: AddOptions, ) -> Pin<Box<dyn Future<Output = StorageResult<QueueOpInfo>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Adds a request and returns its deduplication status.
Source§

fn add_batch<'life0, 'async_trait>( &'life0 self, requests: Vec<RequestSource>, opts: AddOptions, ) -> Pin<Box<dyn Future<Output = StorageResult<BatchAddHandle>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Adds multiple request sources and returns a handle for deferred completion.
Source§

fn fetch_next<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = StorageResult<Option<Lease>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Hands temporary ownership of the next request to the caller as a lease.
Source§

fn mark_handled<'life0, 'async_trait>( &'life0 self, lease: Lease, ) -> Pin<Box<dyn Future<Output = StorageResult<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Marks a leased request as successful and consumes its lease.
Source§

fn reclaim<'life0, 'async_trait>( &'life0 self, lease: Lease, opts: ReclaimOptions, ) -> Pin<Box<dyn Future<Output = StorageResult<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Re-queues a lease, incrementing retry count unless opts disables it. Read more
Source§

fn renew<'life0, 'life1, 'async_trait>( &'life0 self, lease_id: &'life1 LeaseId, extend_by: Duration, ) -> Pin<Box<dyn Future<Output = StorageResult<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Extends an active lease deadline, returning LeaseNotFound if it is unknown or completed.
Source§

fn abandon<'life0, 'async_trait>( &'life0 self, lease: Lease, ) -> Pin<Box<dyn Future<Output = StorageResult<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Re-queues and consumes a lease without incrementing its request retry count. Read more
Source§

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

Returns whether no requests are currently pending.
Source§

fn is_finished<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = StorageResult<bool>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Returns whether no requests are pending or leased.
Source§

fn handled_count<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = StorageResult<u64>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Returns the number of successfully handled requests.
Source§

fn pending_count<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = StorageResult<u64>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Returns the number of pending requests.

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