Skip to main content

PriorityQueue

Struct PriorityQueue 

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

A priority queue for PromptRequest items that orders requests by Priority and, within the same tier, by arrival time (FIFO).

§Capacity

PriorityQueue::new creates a queue with capacity 10 000. Use PriorityQueue::with_capacity for custom sizing. When the queue is full, PriorityQueue::push returns Err(QueueError::QueueFull).

§Deadline enforcement

Use PriorityQueue::pop_with_deadline_check to automatically skip requests whose deadline has already passed. Each skipped request is counted in expired_total (accessible via QueueStats) and a tracing::warn! is emitted.

§Thread safety

PriorityQueue is Clone + Send + Sync. All clones share the same underlying heap behind a Mutex.

§Examples

use std::collections::HashMap;
use tokio_prompt_orchestrator::{PromptRequest, SessionId};
use tokio_prompt_orchestrator::enhanced::{PriorityQueue, Priority};

let queue = PriorityQueue::new();

let req = PromptRequest {
    session: SessionId::new("s1"),
    request_id: "r1".to_string(),
    input: "hello".to_string(),
    meta: HashMap::new(),
    deadline: None,
};

queue.push(Priority::High, req).await.unwrap();

if let Some((priority, request)) = queue.pop().await {
    println!("{priority:?}: {}", request.input);
}

Implementations§

Source§

impl PriorityQueue

Source

pub fn new() -> Self

Create a PriorityQueue with the default capacity of 10 000 entries.

See also PriorityQueue::with_capacity.

Source

pub fn with_capacity(max_size: usize) -> Self

Create a PriorityQueue with a specific maximum capacity.

A capacity of 0 causes every push to return Err(QueueError::QueueFull) immediately.

Source

pub async fn push( &self, priority: Priority, request: PromptRequest, ) -> Result<(), QueueError>

Push a request onto the queue with the given priority.

§Arguments
§Errors

Returns Err(QueueError::QueueFull) if the queue has reached its capacity. The request is not enqueued in that case.

Source

pub async fn pop(&self) -> Option<(Priority, PromptRequest)>

Remove and return the highest-priority request.

Among requests with equal priority the one inserted first is returned (FIFO within a tier).

§Returns

Some((priority, request)) if the queue is non-empty, otherwise None.

Source

pub async fn pop_with_deadline_check(&self) -> Option<(Priority, PromptRequest)>

Remove and return the highest-priority request whose deadline has not yet passed.

Requests are popped in priority order (highest first, then FIFO). Any request whose deadline is Some(t) and t < Instant::now() is silently discarded: the expired_total counter is incremented, a tracing::warn! is emitted, and the next candidate is checked.

Requests with deadline = None are never expired.

§Returns

Some((priority, request)) for the first non-expired request found, or None if the queue is empty or all remaining requests have expired.

§Panics

This function does not panic.

Source

pub async fn len(&self) -> usize

Get current queue size

Source

pub async fn is_empty(&self) -> bool

Check if queue is empty

Source

pub async fn stats(&self) -> QueueStats

Get queue statistics by priority.

Reads from lock-free atomic counters — O(1), no mutex held.

Source

pub async fn clear(&self)

Clear all requests

Trait Implementations§

Source§

impl Clone for PriorityQueue

Source§

fn clone(&self) -> PriorityQueue

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Default for PriorityQueue

Source§

fn default() -> Self

Returns the “default value” for a type. 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
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> FromRef<T> for T
where T: Clone,

§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
§

impl<T> FutureExt for T

§

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

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

fn with_current_context(self) -> WithContext<Self>

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

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

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

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
§

impl<T> PolicyExt for T
where T: ?Sized,

§

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
§

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
§

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more