melinoe 0.10.0

Zero-sized, branded, multi-token phantom capabilities for compile-time data-access and thread-synchronization proofs (a generalized evolution of GhostCell) for the Mnemosyne memory ecosystem.
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

use crate::cell::MelinoeCell;

use super::WriterShard;

/// Iterator over disjoint [`WriterShard`]s produced by [`WriterShard::chunks`].
///
/// Each yielded shard owns a non-overlapping sub-slice carved off the front of
/// the remaining region with [`slice::split_at_mut`], so all yielded shards are
/// mutually disjoint and may be written in parallel.
#[must_use = "iterators are lazy and do nothing unless consumed"]
pub struct ShardChunks<'a, 'brand, T> {
    pub(super) rest: Option<&'a mut [MelinoeCell<'brand, T>]>,
    pub(super) chunk: usize,
}

impl<'a, 'brand, T> Iterator for ShardChunks<'a, 'brand, T> {
    type Item = WriterShard<'a, 'brand, T>;

    #[inline]
    fn next(&mut self) -> Option<Self::Item> {
        let slice = self.rest.take()?;
        if slice.is_empty() {
            return None;
        }
        let mid = self.chunk.min(slice.len());
        let (head, tail) = slice.split_at_mut(mid);
        self.rest = Some(tail);
        Some(WriterShard::new(head))
    }

    /// Exact remaining shard count: `ceil(remaining / chunk)`, the single source
    /// of truth the partition driver reserves worker capacity from.
    ///
    /// `chunk` is `>= 1` (clamped in [`WriterShard::chunks`]), so it delegates
    /// to the crate's single overflow-safe ceiling, `partition_count(len,
    /// chunk)`, shared with [`ParChunks::len`](super::ParChunks::len).
    #[inline]
    fn size_hint(&self) -> (usize, Option<usize>) {
        let remaining = self.rest.as_ref().map_or(0, |s| s.len());
        let shards = super::partition_count(remaining, self.chunk);
        (shards, Some(shards))
    }
}

// `size_hint` returns an exact, consistent bound (the remaining shard count is
// fully determined by the unconsumed length and the fixed `chunk`), so the
// iterator is exact-size; the default `len` derives from `size_hint`.
impl<'a, 'brand, T> ExactSizeIterator for ShardChunks<'a, 'brand, T> {}

impl<'a, 'brand, T> core::fmt::Debug for ShardChunks<'a, 'brand, T> {
    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
        let remaining = self.rest.as_ref().map_or(0, |s| s.len());
        f.debug_struct("ShardChunks")
            .field("remaining", &remaining)
            .field("chunk", &self.chunk)
            .finish()
    }
}