o3 0.11.0

shared-nothing primitives
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
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126

use std::{marker::PhantomData, ptr::NonNull};

use crate::buffer::PoolLayoutError;

mod core;
mod cursor;
mod frozen;
mod layout;
mod lease;
mod plan;
mod state;

use core::Core;

pub use cursor::Cursor;
pub use frozen::Frozen;
pub use layout::Layout;
pub use lease::Lease;
pub use plan::Plan;
#[doc(hidden)]
pub use state::{Initialized, State, Uninitialized};

pub trait PoolCapacitySealed {}

/// Selects whether a pool capacity is fixed in its type or stored in its layout.
///
/// This bound is sealed because the allocator's layout proof depends on it.
#[doc(hidden)]
pub trait PoolCapacity: PoolCapacitySealed {}

#[repr(transparent)]
pub struct Pool<S: State = Uninitialized, C: PoolCapacity = RuntimePoolCapacity> {
    core: NonNull<Core>,
    marker: PhantomData<(S, C, *mut ())>,
}

impl<S: State> Pool<S, RuntimePoolCapacity> {
    pub fn from_layout(layout: Layout) -> Self {
        Self {
            core: Core::allocate::<S>(layout),
            marker: PhantomData,
        }
    }

    pub fn try_new(slots: usize, capacity: usize) -> Result<Self, PoolLayoutError> {
        Ok(Self::from_layout(Layout::new(slots, capacity)?))
    }
}

impl<S: State, C: PoolCapacity> Pool<S, C> {
    pub fn try_acquire(&self) -> Option<Lease<S, C>> {
        let index = Core::acquire(self.core)?;
        Some(Lease {
            core: self.core,
            index,
            len: 0,
            marker: PhantomData,
        })
    }

    pub fn capacity(&self) -> usize {
        Core::capacity(self.core)
    }

    pub fn available(&self) -> usize {
        Core::available(self.core)
    }
}

impl<S: State, const CAP: u32> Pool<S, FixedPoolCapacity<CAP>> {
    pub fn try_with_slots(slots: usize) -> Result<Self, PoolLayoutError> {
        let layout = Layout::new(slots, CAP as usize)?;
        Ok(Self {
            core: Core::allocate::<S>(layout),
            marker: PhantomData,
        })
    }

    #[must_use]
    pub fn fixed<const SLOTS: usize>() -> Self {
        let layout = Layout::fixed_capacity::<SLOTS, CAP>();
        Self {
            core: Core::allocate::<S>(layout),
            marker: PhantomData,
        }
    }
}

impl<C: PoolCapacity> Pool<Uninitialized, C> {
    #[must_use]
    pub fn try_acquire_buffer(&self) -> Option<Cursor<C>> {
        self.try_acquire().map(Cursor::new)
    }
}

impl<S: State, C: PoolCapacity> Clone for Pool<S, C> {
    fn clone(&self) -> Self {
        Core::retain(self.core);
        Self {
            core: self.core,
            marker: PhantomData,
        }
    }
}

impl<S: State, C: PoolCapacity> Drop for Pool<S, C> {
    fn drop(&mut self) {
        Core::release(self.core);
    }
}

/// Selects a capacity supplied by [`Layout`] at construction time.
#[derive(Clone, Copy)]
pub struct RuntimePoolCapacity;

impl PoolCapacitySealed for RuntimePoolCapacity {}

impl PoolCapacity for RuntimePoolCapacity {}

/// Selects a capacity fixed in the pool type.
#[derive(Clone, Copy)]
pub struct FixedPoolCapacity<const CAP: u32>;

impl<const CAP: u32> PoolCapacitySealed for FixedPoolCapacity<CAP> {}

impl<const CAP: u32> PoolCapacity for FixedPoolCapacity<CAP> {}