Skip to main content

Read

Struct Read 

Source
pub struct Read<T>(/* private fields */)
where
    T: Component;
Expand description

Reads a single entity data component type from a chunk.

Trait Implementations§

Source§

impl<T> Clone for Read<T>
where T: Component,

Source§

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

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T> Copy for Read<T>
where T: Component,

Source§

impl<T> Debug for Read<T>
where T: Debug + Component,

Source§

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

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

impl<T> Default for Read<T>
where T: Component,

Source§

fn default() -> Read<T>

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

impl<'a, T> DefaultFilter for Read<T>
where T: Component,

Source§

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

The type of entity filter constructed.
Source§

fn filter() -> <Read<T> as DefaultFilter>::Filter

constructs an entity filter.
Source§

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

Source§

type PreparedResources = PreparedRead<T>

Source§

unsafe fn fetch_unchecked( resources: &Resources, ) -> <Read<T> as ResourceSet>::PreparedResources

Fetches all defined resources, without checking mutability. Read more
Source§

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

Source§

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

Source§

impl<'a, T> View<'a> for Read<T>
where T: Component,

Source§

type Iter = RefIter<'a, T, Iter<'a, T>>

The iterator over the chunk data.
Source§

fn fetch( _: &'a ArchetypeData, chunk: &'a ComponentStorage, _: ChunkIndex, _: SetIndex, ) -> <Read<T> as View<'a>>::Iter

Pulls data out of a chunk.
Source§

fn validate() -> bool

Validates that the view does not break any component borrowing rules.
Source§

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

Determines if the view reads the specified data type.
Source§

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

Determines if the view writes to the specified data type.
Source§

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

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

fn requires_permissions() -> Permissions<ComponentTypeId>

Returns the set of permissions required by the view.

Auto Trait Implementations§

§

impl<T> Freeze for Read<T>

§

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

§

impl<T> Send for Read<T>

§

impl<T> Sync for Read<T>

§

impl<T> Unpin for Read<T>
where T: Unpin,

§

impl<T> UnsafeUnpin for Read<T>

§

impl<T> UnwindSafe for Read<T>
where T: UnwindSafe,

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: Send + Sync + 'static,

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 + Sync + Send>

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> IntoQuery for T
where T: DefaultFilter + for<'a> View<'a>,

Source§

fn query() -> Query<T, <T as DefaultFilter>::Filter>

Converts the View type into a Query.
Source§

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

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.