chunked 0.1.1

An Entity Component System that works by organising like entities into chunks
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
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179

use std::sync::Arc;

use rayon::iter::{IndexedParallelIterator, ParallelIterator};
use rayon::iter::plumbing::{bridge, Consumer, Producer, ProducerCallback, UnindexedConsumer};

use crate::{Archetype, Chunk};
use crate::chunk_set::ChunkSet;
use crate::world::ChunkGuard;
use crate::world::transaction::Transaction;

/// A guard that holds a `ChunkSet` read-write lock.
pub struct ChunkSetGuard<'a> {
    transaction: &'a Transaction,
    archetype: Arc<Archetype>,
    chunk_set: &'a ChunkSet,
}

impl<'a> ChunkSetGuard<'a> {
    /// Create a new `ChunkSetGuard`.
    pub(crate) fn new(
        transaction: &'a Transaction,
        archetype: Arc<Archetype>,
        chunk_set: &'a ChunkSet,
    ) -> ChunkSetGuard<'a> {
        ChunkSetGuard {
            transaction,
            archetype,
            chunk_set,
        }
    }


    /// Get the archetype this `ChunkSet` belongs to.
    pub fn archetype(&self) -> &Arc<Archetype> {
        &self.archetype
    }

    /// Get the number of chunks in this set.
    pub fn len(&self) -> usize {
        self.chunk_set.len()
    }

    /// Fetch a single `Chunk` from this guard.
    pub fn chunk_mut(&mut self, idx: usize) -> Option<ChunkGuard<'_>> {
        self.chunk_set.get(idx).map(|chunk| {
            ChunkGuard::new(self.transaction, chunk)
        })
    }

    /// Iterate over all `Chunk`s in this guard.
    pub fn iter_chunks_mut(&mut self) -> ChunkIter<'a> {
        ChunkIter::new(self.transaction, self.chunk_set.chunks())
    }

    /// Iterate over all `Chunk`s in this guard, in parallel.
    pub fn par_iter_chunks_mut(&mut self) -> ChunkParIter<'a> {
        ChunkParIter::new(self.transaction, self.chunk_set.chunks())
    }
}

/// An iterator over all of the chunks in a `ChunkSetGuard`.
pub struct ChunkIter<'a> {
    transaction: &'a Transaction,
    slice: &'a [Arc<Chunk>],
    offset: usize,
}

impl<'a> ChunkIter<'a> {
    // Create a new `ChunkIter`.
    pub(crate) fn new(transaction: &'a Transaction, slice: &'a [Arc<Chunk>]) -> ChunkIter<'a> {
        ChunkIter {
            transaction,
            slice,
            offset: 0,
        }
    }
}

impl<'a> Iterator for ChunkIter<'a> {
    type Item = ChunkGuard<'a>;

    fn next(&mut self) -> Option<Self::Item> {
        self.slice.get(self.offset).map(|chunk| {
            self.offset += 1;
            ChunkGuard::new(self.transaction, chunk)
        })
    }

    fn size_hint(&self) -> (usize, Option<usize>) {
        let len = self.slice.len() - self.offset;
        (len, Some(len))
    }
}

impl<'a> DoubleEndedIterator for ChunkIter<'a> {
    fn next_back(&mut self) -> Option<Self::Item> {
        if self.offset == 0 {
            return None;
        }

        self.offset -= 1;
        self.slice.get(self.offset).map(|chunk| {
            ChunkGuard::new(self.transaction, chunk)
        })
    }
}

impl<'a> ExactSizeIterator for ChunkIter<'a> {}


/// A parallel iterator over all chunks in a `ChunkSetGuard`.
pub struct ChunkParIter<'a> {
    transaction: &'a Transaction,
    slice: &'a [Arc<Chunk>],
}

impl<'a> ChunkParIter<'a> {
    pub(crate) fn new(transaction: &'a Transaction, slice: &'a [Arc<Chunk>]) -> ChunkParIter<'a> {
        ChunkParIter {
            transaction,
            slice,
        }
    }
}

impl<'a> ParallelIterator for ChunkParIter<'a> {
    type Item = ChunkGuard<'a>;

    fn drive_unindexed<C>(self, consumer: C) -> <C as Consumer<Self::Item>>::Result where
        C: UnindexedConsumer<Self::Item> {
        bridge(self, consumer)
    }
}

impl<'a> IndexedParallelIterator for ChunkParIter<'a> {
    fn len(&self) -> usize {
        self.slice.len()
    }

    fn drive<C: Consumer<Self::Item>>(self, consumer: C) -> <C as Consumer<Self::Item>>::Result {
        bridge(self, consumer)
    }

    fn with_producer<CB: ProducerCallback<Self::Item>>(self, callback: CB) -> <CB as ProducerCallback<Self::Item>>::Output {
        callback.callback(ChunkProducer::new(self.transaction, self.slice))
    }
}

/// A producer for iterating over chunks in a set in parallel.
pub(crate) struct ChunkProducer<'a> {
    transaction: &'a Transaction,
    slice: &'a [Arc<Chunk>],
}

impl<'a> ChunkProducer<'a> {
    /// Create a new `ChunkProducer`.
    pub fn new(transaction: &'a Transaction, slice: &'a [Arc<Chunk>]) -> ChunkProducer<'a> {
        ChunkProducer {
            transaction,
            slice,
        }
    }
}

impl<'a> Producer for ChunkProducer<'a> {
    type Item = ChunkGuard<'a>;
    type IntoIter = ChunkIter<'a>;

    fn into_iter(self) -> Self::IntoIter {
        ChunkIter::new(self.transaction, self.slice)
    }

    fn split_at(self, index: usize) -> (Self, Self) {
        let (left, right) = self.slice.split_at(index);
        let left = ChunkProducer::new(self.transaction, left);
        let right = ChunkProducer::new(self.transaction, right);
        (left, right)
    }
}