brood 0.9.1

A fast and flexible entity component system library.
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

use crate::{
    registry::Registry,
    world::World,
};

pub struct SendableWorld<R, Resources>(*mut World<R, Resources>)
where
    R: Registry;

impl<R, Resources> SendableWorld<R, Resources>
where
    R: Registry,
{
    /// # Safety
    /// The `world` pointer passed here must be exclusively.
    pub(crate) unsafe fn new(world: *mut World<R, Resources>) -> Self {
        Self(world)
    }

    /// # Safety
    /// The pointer returned here must only be used for access to components that follow Rust's
    /// borrowing rules.
    pub(crate) unsafe fn get(self) -> *mut World<R, Resources> {
        self.0
    }
}

impl<R, Resources> Clone for SendableWorld<R, Resources>
where
    R: Registry,
{
    fn clone(&self) -> Self {
        *self
    }
}

impl<R, Resources> Copy for SendableWorld<R, Resources> where R: Registry {}

// SAFETY: This type can be safely sent between threads as long as the safety contracts of its
// methods are upheld, because the data accessed will be accessed uniquely.
unsafe impl<R, Resources> Send for SendableWorld<R, Resources> where R: Registry {}

// SAFETY: This type can be safely shared between threads as long as the safety contracts of its
// methods are upheld, because the data accessed will be accessed uniquely, including mutable
// reference access.
unsafe impl<R, Resources> Sync for SendableWorld<R, Resources> where R: Registry {}