Skip to main content

PreemptiveResource

Struct PreemptiveResource 

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

A cloneable handle to a capacity-limited pool whose held units can be preempted by higher-priority requests.

Like PriorityResource, units are requested at a priority (lower number = higher priority) and blocked waiters are served in priority order. Unlike it, when every unit is in use a higher-priority request does not wait behind the holders — it evicts the lowest-priority holder whose priority is strictly worse than its own, taking that unit immediately.

Preemption is cooperative-at-yield: a higher-priority request fires the victim’s preempted signal, and the victim is expected to bail via any_of![work, guard.preempted()]. A well-behaved holder races its work against that signal:

use simu::{SimEnv, PreemptiveResource, any_of};
let mut env = SimEnv::with_seed(0);
let res = PreemptiveResource::new(1);
let h = env.handle();
let r = res.clone();
env.spawn(async move {
    let guard = r.request(2).await;
    let service = 10.0;
    // Race the service time against a possible preemption.
    any_of![h.timeout(service), guard.preempted()].await;
    if guard.is_preempted() {
        // Higher-priority work took the unit — abandon and clean up.
        return;
    }
    // Completed normally; dropping the guard releases the unit.
});
env.run();

PreemptiveResource wraps an Rc<RefCell<>> internally, so cloning is cheap and all clones share the same pool. It is !Send + !Sync.

Implementations§

Source§

impl PreemptiveResource

Source

pub fn new(capacity: usize) -> Self

Create a new preemptive resource pool with the given capacity.

§Panics

Panics if capacity is zero.

Source

pub fn request(&self, priority: u32) -> PreemptiveRequest

Request one unit at the given priority (lower = higher priority).

Resolves immediately if a unit is free or if a strictly lower-priority holder can be preempted; otherwise suspends in priority order until a unit is released or becomes preemptible.

The returned PreemptiveGuard releases the unit when dropped, and exposes preempted / is_preempted so the holder can yield the unit cooperatively.

Source

pub fn in_use(&self) -> usize

Number of units currently in use.

Source

pub fn capacity(&self) -> usize

Total capacity of this resource pool.

Source

pub fn queue_len(&self) -> usize

Number of processes currently blocked waiting for a unit (i.e. those that could neither take a free unit nor preempt a holder). Excludes abandoned (canceled) requests and current holders.

Trait Implementations§

Source§

impl Clone for PreemptiveResource

Source§

fn clone(&self) -> PreemptiveResource

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 Debug for PreemptiveResource

Source§

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

Formats the value using the given formatter. 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
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.

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

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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.
Source§

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

Source§

fn vzip(self) -> V