Trait legion_systems::resource::ResourceSet

pub trait ResourceSet: Send + Sync {
    type PreparedResources;
    unsafe fn fetch_unchecked(resources: &Resources) -> Self::PreparedResources;

    fn fetch_mut(resources: &mut Resources) -> Self::PreparedResources { ... }
    fn fetch(resources: &Resources) -> Self::PreparedResources
    where
        Self: ReadOnly,
    { ... }
}

Trait which is implemented for tuples of resources and singular resources. This abstracts fetching resources to allow for ergonomic fetching.

Example:

struct TypeA(usize);
struct TypeB(usize);

use legion_core::prelude::*;
use legion_systems::prelude::*;
let mut resources = Resources::default();
resources.insert(TypeA(55));
resources.insert(TypeB(12));

{
    let (a, mut b) = <(Read<TypeA>, Write<TypeB>)>::fetch_mut(&mut resources);
    assert_ne!(a.0, b.0);
    b.0 = a.0;
}

{
    let (a, b) = <(Read<TypeA>, Read<TypeB>)>::fetch(&resources);
    assert_eq!(a.0, b.0);
}

Associated Types

type PreparedResources

Loading content...

Required methods

unsafe fn fetch_unchecked(resources: &Resources) -> Self::PreparedResources

Fetches all defined resources, without checking mutability.

Safety

It is up to the end user to validate proper mutability rules across the resources being accessed.

Loading content...

Provided methods

fn fetch_mut(resources: &mut Resources) -> Self::PreparedResources

fn fetch(resources: &Resources) -> Self::PreparedResources where
    Self: ReadOnly, 

Loading content...

Implementations on Foreign Types

impl ResourceSet for ()

type PreparedResources = ()

unsafe fn fetch_unchecked(_: &Resources)

impl<T: Resource> ResourceSet for Read<T>

type PreparedResources = PreparedRead<T>

unsafe fn fetch_unchecked(resources: &Resources) -> Self::PreparedResources

impl<T: Resource> ResourceSet for Write<T>

type PreparedResources = PreparedWrite<T>

unsafe fn fetch_unchecked(resources: &Resources) -> Self::PreparedResources

impl<A: ResourceSet> ResourceSet for (A,)

type PreparedResources = (A::PreparedResources,)

unsafe fn fetch_unchecked(resources: &Resources) -> Self::PreparedResources

impl<A: ResourceSet, B: ResourceSet> ResourceSet for (A, B)

type PreparedResources = (A::PreparedResources, B::PreparedResources)

unsafe fn fetch_unchecked(resources: &Resources) -> Self::PreparedResources

impl<A: ResourceSet, B: ResourceSet, C: ResourceSet> ResourceSet for (A, B, C)

type PreparedResources = (A::PreparedResources, B::PreparedResources, C::PreparedResources)

unsafe fn fetch_unchecked(resources: &Resources) -> Self::PreparedResources

impl<A: ResourceSet, B: ResourceSet, C: ResourceSet, D: ResourceSet> ResourceSet for (A, B, C, D)

type PreparedResources = (A::PreparedResources, B::PreparedResources, C::PreparedResources, D::PreparedResources)

unsafe fn fetch_unchecked(resources: &Resources) -> Self::PreparedResources

impl<A: ResourceSet, B: ResourceSet, C: ResourceSet, D: ResourceSet, E: ResourceSet> ResourceSet for (A, B, C, D, E)

type PreparedResources = (A::PreparedResources, B::PreparedResources, C::PreparedResources, D::PreparedResources, E::PreparedResources)

unsafe fn fetch_unchecked(resources: &Resources) -> Self::PreparedResources

impl<A: ResourceSet, B: ResourceSet, C: ResourceSet, D: ResourceSet, E: ResourceSet, F: ResourceSet> ResourceSet for (A, B, C, D, E, F)

type PreparedResources = (A::PreparedResources, B::PreparedResources, C::PreparedResources, D::PreparedResources, E::PreparedResources, F::PreparedResources)

unsafe fn fetch_unchecked(resources: &Resources) -> Self::PreparedResources

impl<A: ResourceSet, B: ResourceSet, C: ResourceSet, D: ResourceSet, E: ResourceSet, F: ResourceSet, G: ResourceSet> ResourceSet for (A, B, C, D, E, F, G)

type PreparedResources = (A::PreparedResources, B::PreparedResources, C::PreparedResources, D::PreparedResources, E::PreparedResources, F::PreparedResources, G::PreparedResources)

unsafe fn fetch_unchecked(resources: &Resources) -> Self::PreparedResources

impl<A: ResourceSet, B: ResourceSet, C: ResourceSet, D: ResourceSet, E: ResourceSet, F: ResourceSet, G: ResourceSet, H: ResourceSet> ResourceSet for (A, B, C, D, E, F, G, H)

type PreparedResources = (A::PreparedResources, B::PreparedResources, C::PreparedResources, D::PreparedResources, E::PreparedResources, F::PreparedResources, G::PreparedResources, H::PreparedResources)

unsafe fn fetch_unchecked(resources: &Resources) -> Self::PreparedResources

impl<A: ResourceSet, B: ResourceSet, C: ResourceSet, D: ResourceSet, E: ResourceSet, F: ResourceSet, G: ResourceSet, H: ResourceSet, I: ResourceSet> ResourceSet for (A, B, C, D, E, F, G, H, I)

type PreparedResources = (A::PreparedResources, B::PreparedResources, C::PreparedResources, D::PreparedResources, E::PreparedResources, F::PreparedResources, G::PreparedResources, H::PreparedResources, I::PreparedResources)

unsafe fn fetch_unchecked(resources: &Resources) -> Self::PreparedResources

impl<A: ResourceSet, B: ResourceSet, C: ResourceSet, D: ResourceSet, E: ResourceSet, F: ResourceSet, G: ResourceSet, H: ResourceSet, I: ResourceSet, J: ResourceSet> ResourceSet for (A, B, C, D, E, F, G, H, I, J)

type PreparedResources = (A::PreparedResources, B::PreparedResources, C::PreparedResources, D::PreparedResources, E::PreparedResources, F::PreparedResources, G::PreparedResources, H::PreparedResources, I::PreparedResources, J::PreparedResources)

unsafe fn fetch_unchecked(resources: &Resources) -> Self::PreparedResources

impl<A: ResourceSet, B: ResourceSet, C: ResourceSet, D: ResourceSet, E: ResourceSet, F: ResourceSet, G: ResourceSet, H: ResourceSet, I: ResourceSet, J: ResourceSet, K: ResourceSet> ResourceSet for (A, B, C, D, E, F, G, H, I, J, K)

type PreparedResources = (A::PreparedResources, B::PreparedResources, C::PreparedResources, D::PreparedResources, E::PreparedResources, F::PreparedResources, G::PreparedResources, H::PreparedResources, I::PreparedResources, J::PreparedResources, K::PreparedResources)

unsafe fn fetch_unchecked(resources: &Resources) -> Self::PreparedResources

impl<A: ResourceSet, B: ResourceSet, C: ResourceSet, D: ResourceSet, E: ResourceSet, F: ResourceSet, G: ResourceSet, H: ResourceSet, I: ResourceSet, J: ResourceSet, K: ResourceSet, L: ResourceSet> ResourceSet for (A, B, C, D, E, F, G, H, I, J, K, L)

type PreparedResources = (A::PreparedResources, B::PreparedResources, C::PreparedResources, D::PreparedResources, E::PreparedResources, F::PreparedResources, G::PreparedResources, H::PreparedResources, I::PreparedResources, J::PreparedResources, K::PreparedResources, L::PreparedResources)

unsafe fn fetch_unchecked(resources: &Resources) -> Self::PreparedResources

impl<A: ResourceSet, B: ResourceSet, C: ResourceSet, D: ResourceSet, E: ResourceSet, F: ResourceSet, G: ResourceSet, H: ResourceSet, I: ResourceSet, J: ResourceSet, K: ResourceSet, L: ResourceSet, M: ResourceSet> ResourceSet for (A, B, C, D, E, F, G, H, I, J, K, L, M)

type PreparedResources = (A::PreparedResources, B::PreparedResources, C::PreparedResources, D::PreparedResources, E::PreparedResources, F::PreparedResources, G::PreparedResources, H::PreparedResources, I::PreparedResources, J::PreparedResources, K::PreparedResources, L::PreparedResources, M::PreparedResources)

unsafe fn fetch_unchecked(resources: &Resources) -> Self::PreparedResources

impl<A: ResourceSet, B: ResourceSet, C: ResourceSet, D: ResourceSet, E: ResourceSet, F: ResourceSet, G: ResourceSet, H: ResourceSet, I: ResourceSet, J: ResourceSet, K: ResourceSet, L: ResourceSet, M: ResourceSet, N: ResourceSet> ResourceSet for (A, B, C, D, E, F, G, H, I, J, K, L, M, N)

type PreparedResources = (A::PreparedResources, B::PreparedResources, C::PreparedResources, D::PreparedResources, E::PreparedResources, F::PreparedResources, G::PreparedResources, H::PreparedResources, I::PreparedResources, J::PreparedResources, K::PreparedResources, L::PreparedResources, M::PreparedResources, N::PreparedResources)

unsafe fn fetch_unchecked(resources: &Resources) -> Self::PreparedResources

impl<A: ResourceSet, B: ResourceSet, C: ResourceSet, D: ResourceSet, E: ResourceSet, F: ResourceSet, G: ResourceSet, H: ResourceSet, I: ResourceSet, J: ResourceSet, K: ResourceSet, L: ResourceSet, M: ResourceSet, N: ResourceSet, O: ResourceSet> ResourceSet for (A, B, C, D, E, F, G, H, I, J, K, L, M, N, O)

type PreparedResources = (A::PreparedResources, B::PreparedResources, C::PreparedResources, D::PreparedResources, E::PreparedResources, F::PreparedResources, G::PreparedResources, H::PreparedResources, I::PreparedResources, J::PreparedResources, K::PreparedResources, L::PreparedResources, M::PreparedResources, N::PreparedResources, O::PreparedResources)

unsafe fn fetch_unchecked(resources: &Resources) -> Self::PreparedResources

impl<A: ResourceSet, B: ResourceSet, C: ResourceSet, D: ResourceSet, E: ResourceSet, F: ResourceSet, G: ResourceSet, H: ResourceSet, I: ResourceSet, J: ResourceSet, K: ResourceSet, L: ResourceSet, M: ResourceSet, N: ResourceSet, O: ResourceSet, P: ResourceSet> ResourceSet for (A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P)

type PreparedResources = (A::PreparedResources, B::PreparedResources, C::PreparedResources, D::PreparedResources, E::PreparedResources, F::PreparedResources, G::PreparedResources, H::PreparedResources, I::PreparedResources, J::PreparedResources, K::PreparedResources, L::PreparedResources, M::PreparedResources, N::PreparedResources, O::PreparedResources, P::PreparedResources)

unsafe fn fetch_unchecked(resources: &Resources) -> Self::PreparedResources

impl<A: ResourceSet, B: ResourceSet, C: ResourceSet, D: ResourceSet, E: ResourceSet, F: ResourceSet, G: ResourceSet, H: ResourceSet, I: ResourceSet, J: ResourceSet, K: ResourceSet, L: ResourceSet, M: ResourceSet, N: ResourceSet, O: ResourceSet, P: ResourceSet, Q: ResourceSet> ResourceSet for (A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q)

type PreparedResources = (A::PreparedResources, B::PreparedResources, C::PreparedResources, D::PreparedResources, E::PreparedResources, F::PreparedResources, G::PreparedResources, H::PreparedResources, I::PreparedResources, J::PreparedResources, K::PreparedResources, L::PreparedResources, M::PreparedResources, N::PreparedResources, O::PreparedResources, P::PreparedResources, Q::PreparedResources)

unsafe fn fetch_unchecked(resources: &Resources) -> Self::PreparedResources

impl<A: ResourceSet, B: ResourceSet, C: ResourceSet, D: ResourceSet, E: ResourceSet, F: ResourceSet, G: ResourceSet, H: ResourceSet, I: ResourceSet, J: ResourceSet, K: ResourceSet, L: ResourceSet, M: ResourceSet, N: ResourceSet, O: ResourceSet, P: ResourceSet, Q: ResourceSet, R: ResourceSet> ResourceSet for (A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R)

type PreparedResources = (A::PreparedResources, B::PreparedResources, C::PreparedResources, D::PreparedResources, E::PreparedResources, F::PreparedResources, G::PreparedResources, H::PreparedResources, I::PreparedResources, J::PreparedResources, K::PreparedResources, L::PreparedResources, M::PreparedResources, N::PreparedResources, O::PreparedResources, P::PreparedResources, Q::PreparedResources, R::PreparedResources)

unsafe fn fetch_unchecked(resources: &Resources) -> Self::PreparedResources

impl<A: ResourceSet, B: ResourceSet, C: ResourceSet, D: ResourceSet, E: ResourceSet, F: ResourceSet, G: ResourceSet, H: ResourceSet, I: ResourceSet, J: ResourceSet, K: ResourceSet, L: ResourceSet, M: ResourceSet, N: ResourceSet, O: ResourceSet, P: ResourceSet, Q: ResourceSet, R: ResourceSet, S: ResourceSet> ResourceSet for (A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S)

type PreparedResources = (A::PreparedResources, B::PreparedResources, C::PreparedResources, D::PreparedResources, E::PreparedResources, F::PreparedResources, G::PreparedResources, H::PreparedResources, I::PreparedResources, J::PreparedResources, K::PreparedResources, L::PreparedResources, M::PreparedResources, N::PreparedResources, O::PreparedResources, P::PreparedResources, Q::PreparedResources, R::PreparedResources, S::PreparedResources)

unsafe fn fetch_unchecked(resources: &Resources) -> Self::PreparedResources

impl<A: ResourceSet, B: ResourceSet, C: ResourceSet, D: ResourceSet, E: ResourceSet, F: ResourceSet, G: ResourceSet, H: ResourceSet, I: ResourceSet, J: ResourceSet, K: ResourceSet, L: ResourceSet, M: ResourceSet, N: ResourceSet, O: ResourceSet, P: ResourceSet, Q: ResourceSet, R: ResourceSet, S: ResourceSet, T: ResourceSet> ResourceSet for (A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T)

type PreparedResources = (A::PreparedResources, B::PreparedResources, C::PreparedResources, D::PreparedResources, E::PreparedResources, F::PreparedResources, G::PreparedResources, H::PreparedResources, I::PreparedResources, J::PreparedResources, K::PreparedResources, L::PreparedResources, M::PreparedResources, N::PreparedResources, O::PreparedResources, P::PreparedResources, Q::PreparedResources, R::PreparedResources, S::PreparedResources, T::PreparedResources)

unsafe fn fetch_unchecked(resources: &Resources) -> Self::PreparedResources

impl<A: ResourceSet, B: ResourceSet, C: ResourceSet, D: ResourceSet, E: ResourceSet, F: ResourceSet, G: ResourceSet, H: ResourceSet, I: ResourceSet, J: ResourceSet, K: ResourceSet, L: ResourceSet, M: ResourceSet, N: ResourceSet, O: ResourceSet, P: ResourceSet, Q: ResourceSet, R: ResourceSet, S: ResourceSet, T: ResourceSet, U: ResourceSet> ResourceSet for (A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U)

type PreparedResources = (A::PreparedResources, B::PreparedResources, C::PreparedResources, D::PreparedResources, E::PreparedResources, F::PreparedResources, G::PreparedResources, H::PreparedResources, I::PreparedResources, J::PreparedResources, K::PreparedResources, L::PreparedResources, M::PreparedResources, N::PreparedResources, O::PreparedResources, P::PreparedResources, Q::PreparedResources, R::PreparedResources, S::PreparedResources, T::PreparedResources, U::PreparedResources)

unsafe fn fetch_unchecked(resources: &Resources) -> Self::PreparedResources

impl<A: ResourceSet, B: ResourceSet, C: ResourceSet, D: ResourceSet, E: ResourceSet, F: ResourceSet, G: ResourceSet, H: ResourceSet, I: ResourceSet, J: ResourceSet, K: ResourceSet, L: ResourceSet, M: ResourceSet, N: ResourceSet, O: ResourceSet, P: ResourceSet, Q: ResourceSet, R: ResourceSet, S: ResourceSet, T: ResourceSet, U: ResourceSet, V: ResourceSet> ResourceSet for (A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U, V)

type PreparedResources = (A::PreparedResources, B::PreparedResources, C::PreparedResources, D::PreparedResources, E::PreparedResources, F::PreparedResources, G::PreparedResources, H::PreparedResources, I::PreparedResources, J::PreparedResources, K::PreparedResources, L::PreparedResources, M::PreparedResources, N::PreparedResources, O::PreparedResources, P::PreparedResources, Q::PreparedResources, R::PreparedResources, S::PreparedResources, T::PreparedResources, U::PreparedResources, V::PreparedResources)

unsafe fn fetch_unchecked(resources: &Resources) -> Self::PreparedResources

impl<A: ResourceSet, B: ResourceSet, C: ResourceSet, D: ResourceSet, E: ResourceSet, F: ResourceSet, G: ResourceSet, H: ResourceSet, I: ResourceSet, J: ResourceSet, K: ResourceSet, L: ResourceSet, M: ResourceSet, N: ResourceSet, O: ResourceSet, P: ResourceSet, Q: ResourceSet, R: ResourceSet, S: ResourceSet, T: ResourceSet, U: ResourceSet, V: ResourceSet, W: ResourceSet> ResourceSet for (A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U, V, W)

type PreparedResources = (A::PreparedResources, B::PreparedResources, C::PreparedResources, D::PreparedResources, E::PreparedResources, F::PreparedResources, G::PreparedResources, H::PreparedResources, I::PreparedResources, J::PreparedResources, K::PreparedResources, L::PreparedResources, M::PreparedResources, N::PreparedResources, O::PreparedResources, P::PreparedResources, Q::PreparedResources, R::PreparedResources, S::PreparedResources, T::PreparedResources, U::PreparedResources, V::PreparedResources, W::PreparedResources)

unsafe fn fetch_unchecked(resources: &Resources) -> Self::PreparedResources

impl<A: ResourceSet, B: ResourceSet, C: ResourceSet, D: ResourceSet, E: ResourceSet, F: ResourceSet, G: ResourceSet, H: ResourceSet, I: ResourceSet, J: ResourceSet, K: ResourceSet, L: ResourceSet, M: ResourceSet, N: ResourceSet, O: ResourceSet, P: ResourceSet, Q: ResourceSet, R: ResourceSet, S: ResourceSet, T: ResourceSet, U: ResourceSet, V: ResourceSet, W: ResourceSet, X: ResourceSet> ResourceSet for (A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U, V, W, X)

type PreparedResources = (A::PreparedResources, B::PreparedResources, C::PreparedResources, D::PreparedResources, E::PreparedResources, F::PreparedResources, G::PreparedResources, H::PreparedResources, I::PreparedResources, J::PreparedResources, K::PreparedResources, L::PreparedResources, M::PreparedResources, N::PreparedResources, O::PreparedResources, P::PreparedResources, Q::PreparedResources, R::PreparedResources, S::PreparedResources, T::PreparedResources, U::PreparedResources, V::PreparedResources, W::PreparedResources, X::PreparedResources)

unsafe fn fetch_unchecked(resources: &Resources) -> Self::PreparedResources

impl<A: ResourceSet, B: ResourceSet, C: ResourceSet, D: ResourceSet, E: ResourceSet, F: ResourceSet, G: ResourceSet, H: ResourceSet, I: ResourceSet, J: ResourceSet, K: ResourceSet, L: ResourceSet, M: ResourceSet, N: ResourceSet, O: ResourceSet, P: ResourceSet, Q: ResourceSet, R: ResourceSet, S: ResourceSet, T: ResourceSet, U: ResourceSet, V: ResourceSet, W: ResourceSet, X: ResourceSet, Y: ResourceSet> ResourceSet for (A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U, V, W, X, Y)

type PreparedResources = (A::PreparedResources, B::PreparedResources, C::PreparedResources, D::PreparedResources, E::PreparedResources, F::PreparedResources, G::PreparedResources, H::PreparedResources, I::PreparedResources, J::PreparedResources, K::PreparedResources, L::PreparedResources, M::PreparedResources, N::PreparedResources, O::PreparedResources, P::PreparedResources, Q::PreparedResources, R::PreparedResources, S::PreparedResources, T::PreparedResources, U::PreparedResources, V::PreparedResources, W::PreparedResources, X::PreparedResources, Y::PreparedResources)

unsafe fn fetch_unchecked(resources: &Resources) -> Self::PreparedResources

impl<A: ResourceSet, B: ResourceSet, C: ResourceSet, D: ResourceSet, E: ResourceSet, F: ResourceSet, G: ResourceSet, H: ResourceSet, I: ResourceSet, J: ResourceSet, K: ResourceSet, L: ResourceSet, M: ResourceSet, N: ResourceSet, O: ResourceSet, P: ResourceSet, Q: ResourceSet, R: ResourceSet, S: ResourceSet, T: ResourceSet, U: ResourceSet, V: ResourceSet, W: ResourceSet, X: ResourceSet, Y: ResourceSet, Z: ResourceSet> ResourceSet for (A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U, V, W, X, Y, Z)

type PreparedResources = (A::PreparedResources, B::PreparedResources, C::PreparedResources, D::PreparedResources, E::PreparedResources, F::PreparedResources, G::PreparedResources, H::PreparedResources, I::PreparedResources, J::PreparedResources, K::PreparedResources, L::PreparedResources, M::PreparedResources, N::PreparedResources, O::PreparedResources, P::PreparedResources, Q::PreparedResources, R::PreparedResources, S::PreparedResources, T::PreparedResources, U::PreparedResources, V::PreparedResources, W::PreparedResources, X::PreparedResources, Y::PreparedResources, Z::PreparedResources)

unsafe fn fetch_unchecked(resources: &Resources) -> Self::PreparedResources

Loading content...

Implementors

Loading content...