penguin_app::ecs::query

Struct TryRead

Source 
pub struct TryRead<T>(/* private fields */);
Expand description

Reads a single entity data component type from a chunk.

Trait Implementations§

Source§

impl<T> Clone for TryRead<T>
where T: Clone,

Source§

fn clone(&self) -> TryRead<T>

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T> Debug for TryRead<T>
where T: Debug,

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<T> Default for TryRead<T>

Source§

fn default() -> TryRead<T>

Returns the “default value” for a type. Read more
Source§

impl<T> DefaultFilter for TryRead<T>
where T: Component,

Source§

type Filter = EntityFilterTuple<TryComponentFilter<T>, Passthrough>

The filter constructed.
Source§

impl<'data, T> View<'data> for TryRead<T>
where T: Component,

Source§

type Element = <<TryRead<T> as View<'data>>::Fetch as IntoIndexableIter>::Item

The type of component references returned.
Source§

type Fetch = Slice<'data, T>

The fetch type yielded for each archetype.
Source§

type Iter = TryReadIter<'data, T>

The iterator type which pulls entity data out of a world.
Source§

type Read = [ComponentTypeId; 1]

Contains the type IDs read by the view.
Source§

type Write = [ComponentTypeId; 0]

Contains the type IDs written by the view.
Source§

fn validate()

Determines if this view type is valid. Panics if checks fail.
Source§

fn validate_access(access: &ComponentAccess<'_>) -> bool

Returns true if the given component access includes all permissions required by the view.
Source§

fn reads_types() -> <TryRead<T> as View<'data>>::Read

Returns the component types read by the view.
Source§

fn writes_types() -> <TryRead<T> as View<'data>>::Write

Returns the component types written to by the view.
Source§

fn reads<D>() -> bool
where D: Component,

Returns true if the view reads the specified data type.
Source§

fn writes<D>() -> bool
where D: Component,

Returns true if the view writes to the specified data type.
Source§

fn requires_permissions() -> Permissions<ComponentTypeId>

Returns a permissions struct declaring the component accesses required by the view.
Source§

unsafe fn fetch( components: &'data Components, archetypes: &'data [Archetype], query: QueryResult<'data>, ) -> <TryRead<T> as View<'data>>::Iter

Creates an iterator which will yield slices of entity data for each archetype. Read more
Source§

impl<T> Copy for TryRead<T>
where T: Copy,

Source§

impl<T> Send for TryRead<T>

Source§

impl<T> Sync for TryRead<T>
where T: Sync,

Auto Trait Implementations§

§

impl<T> Freeze for TryRead<T>

§

impl<T> RefUnwindSafe for TryRead<T>
where T: RefUnwindSafe,

§

impl<T> Unpin for TryRead<T>

§

impl<T> UnwindSafe for TryRead<T>
where T: RefUnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> Component for T
where T: 'static + Send + Sync,

Source§

type Storage = PackedStorage<T>

The storage type required to hold all instances of this component in a world.
Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> IntoQuery for T
where T: IntoView,

Source§

fn query() -> Query<T>

Constructs a query.
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> Resource for T
where T: 'static,