pipecircuit 0.0.18

Correct. Robust. Fast. Portable. Pick four.
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

mod creation;
#[cfg(feature = "performance-evidence")]
mod evidence;
mod lease;
mod pool;
mod reservation;

use alloc::{boxed::Box, vec::Vec};
use core::{cell::Cell, ops::Range};

pub use creation::BytePoolCreationError;
#[cfg(feature = "performance-evidence")]
pub use evidence::BytePoolEvidence;
pub use lease::{ByteLease, RetainedByteLease};
pub use pool::{
    BytePoolInconsistency, BytePoolLeaseOutcome, BytePoolRecycleOutcome, BytePoolResumeOutcome,
    BytePoolStatistics,
};
pub use reservation::{ByteLeaseReservation, BytePoolMaterializeOutcome, BytePoolReserveOutcome};

#[derive(Clone, Copy, Debug, Eq, PartialEq)]
enum LeaseStatus {
    Vacant,
    Leased,
    Released,
    Exhausted,
}

struct LeaseRecord {
    identity: Cell<Box<[u8]>>,
    identity_address: usize,
    generation: u64,
    range: Range<usize>,
    status: Cell<LeaseStatus>,
    next: Cell<Option<usize>>,
}

pub struct BytePool {
    storage: Box<[u8]>,
    leases: Box<[LeaseRecord]>,
    free_extents: Vec<Range<usize>>,
    available_lease_head: Option<usize>,
    released_lease_head: Cell<Option<usize>>,
    exhausted_lease_count: usize,
    #[cfg(feature = "performance-evidence")]
    evidence: BytePoolEvidence,
}

#[cfg(test)]
mod tests;