Skip to main content

Resource

Struct Resource 

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

A cloneable handle to a capacity-limited resource pool.

Units are acquired by calling request and awaiting the returned future. If no unit is available the calling process is suspended and woken in FIFO order when one becomes free.

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

Two processes sharing a single-unit pump — the second queues until the first one’s guard drops:

use simu::{SimEnv, Resource};

let mut env = SimEnv::with_seed(0);
let pump = Resource::new(1);

for _ in 0..2 {
    let h = env.handle();
    let p = pump.clone(); // same pool — share by cloning, never Arc
    env.spawn(async move {
        let _guard = p.request().await; // second process suspends here
        h.timeout(3.0).await;           // use the pump for 3 time units
    }); // guard drops → pump handed to the next waiter
}

env.run();
assert_eq!(env.now(), 6.0); // servings ran back-to-back, not in parallel

FIFO ordering is the degenerate WaitQueue<()> case: every waiter shares the same (unit) key, so they are served purely in insertion order.

Implementations§

Source§

impl Resource

Source

pub fn new(capacity: usize) -> Self

Create a new resource pool with the given capacity.

§Panics

Panics if capacity is zero.

Source

pub fn request(&self) -> ResourceRequest

Request one unit. Resolves immediately if a unit is available, otherwise suspends the calling process until one is released.

The returned ResourceGuard releases the unit when dropped.

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 queued waiting for a unit (SimPy’s len(resource.queue)). Excludes abandoned (canceled) requests.

Trait Implementations§

Source§

impl Clone for Resource

Source§

fn clone(&self) -> Resource

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 Resource

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