shipyard 0.11.2

Entity Component System
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

use crate::all_storages::AllStorages;
use crate::atomic_refcell::SharedBorrow;
use crate::borrow::Borrow;
#[cfg(feature = "thread_local")]
use crate::borrow::{NonSend, NonSendSync, NonSync};
use crate::component::Unique;
use crate::error;
use crate::views::{UniqueView, UniqueViewMut};

/// Trait used as bound for [`World::get_unique`] and [`AllStorages::get_unique`].
///
/// [`World::get_unique`]: crate::world::World::get_unique
/// [`AllStorages::get_unique`]: crate::all_storages::AllStorages::get_unique
pub trait GetUnique {
    #[allow(missing_docs)]
    type Out<'a>;

    #[allow(missing_docs)]
    fn get_unique<'a>(
        all_storages: &'a AllStorages,
        all_borrow: Option<SharedBorrow<'a>>,
    ) -> Result<Self::Out<'a>, error::GetStorage>;
}

impl<T: Unique + Send + Sync> GetUnique for &'_ T {
    type Out<'a> = UniqueView<'a, T>;

    #[inline]
    fn get_unique<'a>(
        all_storages: &'a AllStorages,
        all_borrow: Option<SharedBorrow<'a>>,
    ) -> Result<Self::Out<'a>, error::GetStorage> {
        let current = all_storages.get_current();

        <UniqueView<'a, T> as Borrow>::borrow(all_storages, all_borrow, None, current)
    }
}

#[cfg(feature = "thread_local")]
impl<T: Unique + Sync> GetUnique for NonSend<&'_ T> {
    type Out<'a> = NonSend<UniqueView<'a, T>>;

    #[inline]
    fn get_unique<'a>(
        all_storages: &'a AllStorages,
        all_borrow: Option<SharedBorrow<'a>>,
    ) -> Result<Self::Out<'a>, error::GetStorage> {
        let current = all_storages.get_current();

        <NonSend<UniqueView<'a, T>> as Borrow>::borrow(all_storages, all_borrow, None, current)
    }
}

#[cfg(feature = "thread_local")]
impl<T: Unique + Send> GetUnique for NonSync<&'_ T> {
    type Out<'a> = NonSync<UniqueView<'a, T>>;

    #[inline]
    fn get_unique<'a>(
        all_storages: &'a AllStorages,
        all_borrow: Option<SharedBorrow<'a>>,
    ) -> Result<Self::Out<'a>, error::GetStorage> {
        let current = all_storages.get_current();

        <NonSync<UniqueView<'a, T>> as Borrow>::borrow(all_storages, all_borrow, None, current)
    }
}

#[cfg(feature = "thread_local")]
impl<T: Unique> GetUnique for NonSendSync<&'_ T> {
    type Out<'a> = NonSendSync<UniqueView<'a, T>>;

    #[inline]
    fn get_unique<'a>(
        all_storages: &'a AllStorages,
        all_borrow: Option<SharedBorrow<'a>>,
    ) -> Result<Self::Out<'a>, error::GetStorage> {
        let current = all_storages.get_current();

        <NonSendSync<UniqueView<'a, T>> as Borrow>::borrow(all_storages, all_borrow, None, current)
    }
}

impl<T: Unique + Send + Sync> GetUnique for &'_ mut T {
    type Out<'a> = UniqueViewMut<'a, T>;

    #[inline]
    fn get_unique<'a>(
        all_storages: &'a AllStorages,
        all_borrow: Option<SharedBorrow<'a>>,
    ) -> Result<Self::Out<'a>, error::GetStorage> {
        let current = all_storages.get_current();

        <UniqueViewMut<'a, T> as Borrow>::borrow(all_storages, all_borrow, None, current)
    }
}

#[cfg(feature = "thread_local")]
impl<T: Unique + Sync> GetUnique for NonSend<&'_ mut T> {
    type Out<'a> = NonSend<UniqueViewMut<'a, T>>;

    #[inline]
    fn get_unique<'a>(
        all_storages: &'a AllStorages,
        all_borrow: Option<SharedBorrow<'a>>,
    ) -> Result<Self::Out<'a>, error::GetStorage> {
        let current = all_storages.get_current();

        <NonSend<UniqueViewMut<'a, T>> as Borrow>::borrow(all_storages, all_borrow, None, current)
    }
}

#[cfg(feature = "thread_local")]
impl<T: Unique + Send> GetUnique for NonSync<&'_ mut T> {
    type Out<'a> = NonSync<UniqueViewMut<'a, T>>;

    #[inline]
    fn get_unique<'a>(
        all_storages: &'a AllStorages,
        all_borrow: Option<SharedBorrow<'a>>,
    ) -> Result<Self::Out<'a>, error::GetStorage> {
        let current = all_storages.get_current();

        <NonSync<UniqueViewMut<'a, T>> as Borrow>::borrow(all_storages, all_borrow, None, current)
    }
}

#[cfg(feature = "thread_local")]
impl<T: Unique> GetUnique for NonSendSync<&'_ mut T> {
    type Out<'a> = NonSendSync<UniqueViewMut<'a, T>>;

    #[inline]
    fn get_unique<'a>(
        all_storages: &'a AllStorages,
        all_borrow: Option<SharedBorrow<'a>>,
    ) -> Result<Self::Out<'a>, error::GetStorage> {
        let current = all_storages.get_current();

        <NonSendSync<UniqueViewMut<'a, T>> as Borrow>::borrow(
            all_storages,
            all_borrow,
            None,
            current,
        )
    }
}