pub struct PriorityQueue { /* private fields */ }Expand description
Priority-based download queue
Manages concurrent download slots with priority ordering. Higher priority downloads are started before lower priority ones, with FIFO ordering within the same priority level.
Implementations§
Source§impl PriorityQueue
impl PriorityQueue
Sourcepub fn new(max_concurrent: usize) -> Arc<Self>
pub fn new(max_concurrent: usize) -> Arc<Self>
Create a new priority queue with the given concurrency limit
Sourcepub async fn acquire(
self: &Arc<Self>,
id: DownloadId,
priority: DownloadPriority,
) -> PriorityPermit
pub async fn acquire( self: &Arc<Self>, id: DownloadId, priority: DownloadPriority, ) -> PriorityPermit
Acquire a permit for the download to proceed (blocking).
This method adds the download to the waiting queue and blocks until:
- A slot becomes available, AND
- This download is the highest priority in the waiting queue
The download remains in the queue until a permit is granted, ensuring fair ordering based on priority and arrival time (FIFO within same priority).
§Difference from try_acquire
acquire: Adds to queue, waits for turn, guarantees eventual permittry_acquire: Does NOT add to queue, immediate success or failure
Use acquire for downloads that should wait their turn.
Use try_acquire for opportunistic slot acquisition (e.g., resuming paused downloads).
Sourcepub fn try_acquire(
self: &Arc<Self>,
id: DownloadId,
priority: DownloadPriority,
) -> Option<PriorityPermit>
pub fn try_acquire( self: &Arc<Self>, id: DownloadId, priority: DownloadPriority, ) -> Option<PriorityPermit>
Try to acquire a permit immediately without waiting (non-blocking).
This method does NOT add the download to the waiting queue. It either
succeeds immediately or returns None.
Returns None if:
- No slot is currently available, OR
- Higher priority downloads are already waiting in the queue
§Difference from acquire
try_acquire: Does NOT add to queue, immediate success or failureacquire: Adds to queue, waits for turn, guarantees eventual permit
§Use Cases
- Opportunistic slot acquisition (e.g., checking if a paused download can resume)
- Avoiding queue position for downloads that shouldn’t block others
- Non-async contexts where blocking is not possible
§Warning
If you call try_acquire and it fails, the download is NOT queued.
You must call acquire if you want the download to wait for a slot.
Sourcepub fn set_priority(
&self,
id: DownloadId,
new_priority: DownloadPriority,
) -> bool
pub fn set_priority( &self, id: DownloadId, new_priority: DownloadPriority, ) -> bool
Update the priority of a waiting download
If the download is already active, this has no effect on scheduling. Returns true if the priority was updated.
Sourcepub fn remove(&self, id: DownloadId)
pub fn remove(&self, id: DownloadId)
Remove a download from the waiting queue
Call this if a download is cancelled before acquiring a permit.
Sourcepub fn get_priority(&self, id: DownloadId) -> Option<DownloadPriority>
pub fn get_priority(&self, id: DownloadId) -> Option<DownloadPriority>
Get the priority of a download (waiting or active)
Sourcepub fn active_count(&self) -> usize
pub fn active_count(&self) -> usize
Get the number of active downloads
Sourcepub fn waiting_count(&self) -> usize
pub fn waiting_count(&self) -> usize
Get the number of waiting downloads
Sourcepub fn queue_position(&self, id: DownloadId) -> Option<usize>
pub fn queue_position(&self, id: DownloadId) -> Option<usize>
Get the position in queue for a waiting download (1-indexed, None if not waiting)
Sourcepub fn stats(&self) -> PriorityQueueStats
pub fn stats(&self) -> PriorityQueueStats
Get statistics about the queue
Auto Trait Implementations§
impl !Freeze for PriorityQueue
impl !RefUnwindSafe for PriorityQueue
impl Send for PriorityQueue
impl Sync for PriorityQueue
impl Unpin for PriorityQueue
impl !UnwindSafe for PriorityQueue
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> FmtForward for T
impl<T> FmtForward for T
Source§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
self to use its Binary implementation when Debug-formatted.Source§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
self to use its Display implementation when
Debug-formatted.Source§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
self to use its LowerExp implementation when
Debug-formatted.Source§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
self to use its LowerHex implementation when
Debug-formatted.Source§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
self to use its Octal implementation when Debug-formatted.Source§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
self to use its Pointer implementation when
Debug-formatted.Source§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
self to use its UpperExp implementation when
Debug-formatted.Source§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
self to use its UpperHex implementation when
Debug-formatted.Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
Source§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
Source§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
self and passes that borrow into the pipe function. Read moreSource§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
self and passes that borrow into the pipe function. Read moreSource§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
Source§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
Source§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
self, then passes self.as_ref() into the pipe function.Source§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
self, then passes self.as_mut() into the pipe
function.Source§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self, then passes self.deref() into the pipe function.Source§impl<T> PolicyExt for Twhere
T: ?Sized,
impl<T> PolicyExt for Twhere
T: ?Sized,
Source§impl<T> Tap for T
impl<T> Tap for T
Source§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B> of a value. Read moreSource§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B> of a value. Read moreSource§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R> view of a value. Read moreSource§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R> view of a value. Read moreSource§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target of a value. Read moreSource§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target of a value. Read moreSource§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap() only in debug builds, and is erased in release builds.Source§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut() only in debug builds, and is erased in release
builds.Source§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.tap_borrow() only in debug builds, and is erased in release
builds.Source§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.tap_borrow_mut() only in debug builds, and is erased in release
builds.Source§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.tap_ref() only in debug builds, and is erased in release
builds.Source§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.tap_ref_mut() only in debug builds, and is erased in release
builds.Source§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref() only in debug builds, and is erased in release
builds.