slotpool 0.2.1

Fixed-capacity object pools for no_std / embedded systems
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37

//! Abstract interface for managing free slot indices.
//! `Pool` depends only on this trait, not on a particular synchronisation
//! mechanism.
//!
//! Two backends are provided: [`CriticalSlots`](crate::critical::CriticalSlots) (default)
//! and [`CasSlots`](crate::cas::CasSlots) (behind feature `cas`):
//!
//! ```ignore
//! use slotpool::Pool;
//! use slotpool::critical::CriticalSlots;
//! #[cfg(feature = "cas")]
//! use slotpool::cas::CasSlots;
//!
//! type MyPool    = Pool<u8, 16>;                      // default: CriticalSlots
//! type MyCasPool = Pool<u8, 16, CasSlots<16>>;        // explicit CAS backend
//! ```

pub trait FreeSlots<const N: usize>: Sync {
    /// Create an empty collection (no free indices).
    fn new() -> Self;

    /// Fill with indices `0..count`.  `count` must be `<= N`.
    /// Must only be called once, during initialisation.
    fn fill(&self, count: usize) -> Result<(), FillError>;

    /// Take a free index; returns `None` when exhausted.
    /// Safe to call concurrently from any execution context.
    fn take(&self) -> Option<usize>;

    /// Return an index to the free set.
    /// Safe to call concurrently from any execution context.
    fn put(&self, idx: usize);
}

/// Error returned by [`FreeSlots::fill`] when `count` exceeds capacity `N`.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct FillError;