Struct Ref 

pub struct Ref<'w, T: ?Sized> { /* private fields */ }

A custom version of bevy’s Ref that can be constructed from EntityRef and mapped over.

Due to a limitation in bevy, it’s impossible to use the bevy Ref for this crate.

Implementations

impl<'w, T: ?Sized> Ref<'w, T>

pub const fn is_added(&self) -> bool

Was this added since last time the system this is called from ran?

pub const fn is_changed(&self) -> bool

Was this changed since last time the system this is called from ran?

pub const fn into_inner(self) -> &'w T

Return the inner reference with its full lifetime.

Rust’s Deref trait can’t produce references with a lifetime longer than that of the Ref itself (with &'a Ref<'w>, the lifetime will always be 'a).

This can become an issue in certain scenarios, this is why this method exists.

Note that since Ref is Copy, this doesn’t consume the value, you can keep using it.

pub fn map_failable<E, U: ?Sized>( self, f: impl FnOnce(&T) -> Result<&U, E>, ) -> Result<Ref<'w, U>, E>

Apply a function f returning a result to the inner value, and get a Ref with the return value of that function. Returning Err if f returns Err.

Errors

Returns Err if f returns Err.

pub fn map<U: ?Sized>(self, f: impl FnOnce(&T) -> &U) -> Ref<'w, U>

Apply a function f to the inner value, and get a Ref with the return value of that function.

pub fn map_from<U: ?Sized>(bevy: BRef<'w, U>, f: impl FnOnce(&U) -> &T) -> Self

Convert a bevy Ref into a reflect_query Ref, applying a function while converting it.

You can pass |i| i as function if you don’t wish to convert the value.

Trait Implementations

impl<'w, T: ?Sized> AsRef<T> for Ref<'w, T>

fn as_ref(&self) -> &T

Converts this type into a shared reference of the (usually inferred) input type.

impl<'w, T: Clone + ?Sized> Clone for Ref<'w, T>

fn clone(&self) -> Ref<'w, T>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'w, T: Debug + ?Sized> Debug for Ref<'w, T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'w, T: ?Sized> Deref for Ref<'w, T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'w, T: ?Sized> From<Ref<'w, T>> for Ref<'w, T>

fn from(value: BRef<'w, T>) -> Self

Converts to this type from the input type.

impl<'w, 'a, T> IntoIterator for &'a Ref<'w, T>

where &'a T: IntoIterator,

type Item = <&'a T as IntoIterator>::Item

The type of the elements being iterated over.

type IntoIter = <&'a T as IntoIterator>::IntoIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'w, T: Ord + ?Sized> Ord for Ref<'w, T>

fn cmp(&self, other: &Ref<'w, T>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<'w, T: PartialEq + ?Sized> PartialEq for Ref<'w, T>

fn eq(&self, other: &Ref<'w, T>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'w, T: PartialOrd + ?Sized> PartialOrd for Ref<'w, T>

fn partial_cmp(&self, other: &Ref<'w, T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'w, T: Copy + ?Sized> Copy for Ref<'w, T>

impl<'w, T: Eq + ?Sized> Eq for Ref<'w, T>

impl<'w, T: ?Sized> StructuralPartialEq for Ref<'w, T>