Struct oxygengine_core::ecs::Write

pub struct Write<'a, T, F = DefaultProvider> where
    T: 'a,  { /* fields omitted */ }

Allows to fetch a resource in a system mutably.

If the resource isn’t strictly required, you should use Option<Write<T>>.

Type parameters

• T: The type of the resource
• F: The setup handler (default: DefaultProvider)

Trait Implementations

impl<'a, T, F> Deref for Write<'a, T, F> where
    T: Resource, 

type Target = T

The resulting type after dereferencing.

pub fn deref(&self) -> &T

Dereferences the value.

impl<'a, T, F> DerefMut for Write<'a, T, F> where
    T: Resource, 

pub fn deref_mut(&mut self) -> &mut T

Mutably dereferences the value.

impl<'a, T, F> From<FetchMut<'a, T>> for Write<'a, T, F>

pub fn from(inner: FetchMut<'a, T>) -> Write<'a, T, F>

Performs the conversion.

impl<'a, 'b, T> Join for &'a mut Write<'b, T, PanicHandler> where
    T: Resource,
    &'a mut T: Join, 

type Type = <&'a mut T as Join>::Type

Type of joined components.

type Value = <&'a mut T as Join>::Value

Type of joined storages.

type Mask = <&'a mut T as Join>::Mask

Type of joined bit mask.

pub unsafe fn open(
    self
) -> (<&'a mut Write<'b, T, PanicHandler> as Join>::Mask, <&'a mut Write<'b, T, PanicHandler> as Join>::Value)

Open this join by returning the mask and the storages.

pub unsafe fn get(
    v: &mut <&'a mut Write<'b, T, PanicHandler> as Join>::Value,
    i: u32
) -> <&'a mut Write<'b, T, PanicHandler> as Join>::Type

Get a joined component value by a given index.

pub fn is_unconstrained() -> bool

If this Join typically returns all indices in the mask, then iterating over only it or combined with other joins that are also dangerous will cause the JoinIter/ParJoin to go through all indices which is usually not what is wanted and will kill performance.

pub fn join(self) -> JoinIter<Self>

Create a joined iterator over the contents.

pub fn maybe(self) -> MaybeJoin<Self>

Returns a Join-able structure that yields all indices, returning None for all missing elements and Some(T) for found elements.

impl<'a, 'b, T> Join for &'a mut Write<'b, T, DefaultProvider> where
    T: Resource,
    &'a mut T: Join, 

type Type = <&'a mut T as Join>::Type

Type of joined components.

type Value = <&'a mut T as Join>::Value

Type of joined storages.

type Mask = <&'a mut T as Join>::Mask

Type of joined bit mask.

pub unsafe fn open(
    self
) -> (<&'a mut Write<'b, T, DefaultProvider> as Join>::Mask, <&'a mut Write<'b, T, DefaultProvider> as Join>::Value)

Open this join by returning the mask and the storages.

pub unsafe fn get(
    v: &mut <&'a mut Write<'b, T, DefaultProvider> as Join>::Value,
    i: u32
) -> <&'a mut Write<'b, T, DefaultProvider> as Join>::Type

Get a joined component value by a given index.

pub fn is_unconstrained() -> bool

If this Join typically returns all indices in the mask, then iterating over only it or combined with other joins that are also dangerous will cause the JoinIter/ParJoin to go through all indices which is usually not what is wanted and will kill performance.

pub fn join(self) -> JoinIter<Self>

Create a joined iterator over the contents.

pub fn maybe(self) -> MaybeJoin<Self>

Returns a Join-able structure that yields all indices, returning None for all missing elements and Some(T) for found elements.

impl<'a, T, F> SystemData<'a> for Write<'a, T, F> where
    T: Resource,
    F: SetupHandler<T>, 

pub fn setup(world: &mut World)

Sets up the system data for fetching it from the World.

pub fn fetch(world: &'a World) -> Write<'a, T, F>

Fetches the system data from World. Note that this is only specified for one concrete lifetime 'a, you need to implement the SystemData trait for every possible lifetime.

pub fn reads() -> Vec<ResourceId, Global>

Returns all read dependencies as fetched from Self::fetch.

pub fn writes() -> Vec<ResourceId, Global>

Returns all write dependencies as fetched from Self::fetch.