Struct xecs::StorageRead

source · [−]

pub struct StorageRead<'a, T> { /* private fields */ }

Expand description

A read gurad for component storage

Implementations

source

impl<'a, T: Component> StorageRead<'a, T>

source

pub fn count(&self) -> usize

Get the count of strorage

source

pub fn exist(&self, id: EntityId) -> bool

Check if id is in storage

source

pub fn get(&self, id: EntityId) -> Option<&T>

Get component from storage by id

Details

Return None if id is not in storage

source

pub unsafe fn get_unchecked(&self, id: EntityId) -> &T

Get component from storage by index

Safety

Safe when id is in storage

source

pub fn is_empty(&self) -> bool

Check storage is empty

source

pub fn data(&self) -> &[T]ⓘNotable traits for &'_ mut [u8 ]`impl<'_> Write for &'_ mut [u8]impl<'_> Read for &'_ [u8]`

Get the data slice

Auto Trait Implementations

impl<'a, T> !RefUnwindSafe for StorageRead<'a, T>

impl<'a, T> !Send for StorageRead<'a, T>

impl<'a, T> !Sync for StorageRead<'a, T>

impl<'a, T> Unpin for StorageRead<'a, T>

impl<'a, T> !UnwindSafe for StorageRead<'a, T>

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,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · 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, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

Struct xecs::StorageRead

Implementations

impl<'a, T: Component> StorageRead<'a, T>

pub fn count(&self) -> usize

pub fn exist(&self, id: EntityId) -> bool

pub fn get(&self, id: EntityId) -> Option<&T>

Details

pub unsafe fn get_unchecked(&self, id: EntityId) -> &T

Safety

pub fn is_empty(&self) -> bool

pub fn data(&self) -> &[T]ⓘNotable traits for &'_ mut [u8 ]`impl<'_> Write for &'_ mut [u8]impl<'_> Read for &'_ [u8]`

Auto Trait Implementations

impl<'a, T> !RefUnwindSafe for StorageRead<'a, T>

impl<'a, T> !Send for StorageRead<'a, T>

impl<'a, T> !Sync for StorageRead<'a, T>

impl<'a, T> Unpin for StorageRead<'a, T>

impl<'a, T> !UnwindSafe for StorageRead<'a, T>

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

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

type Error = Infallible

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

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

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

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

Struct xecs::StorageRead

Implementations

impl<'a, T: Component> StorageRead<'a, T>

pub fn count(&self) -> usize

pub fn exist(&self, id: EntityId) -> bool

pub fn get(&self, id: EntityId) -> Option<&T>

Details

pub unsafe fn get_unchecked(&self, id: EntityId) -> &T

Safety

pub fn is_empty(&self) -> bool

pub fn data(&self) -> &[T]ⓘNotable traits for &'_ mut [u8]impl<'_> Write for &'_ mut [u8]impl<'_> Read for &'_ [u8]

Auto Trait Implementations

impl<'a, T> !RefUnwindSafe for StorageRead<'a, T>

impl<'a, T> !Send for StorageRead<'a, T>

impl<'a, T> !Sync for StorageRead<'a, T>

impl<'a, T> Unpin for StorageRead<'a, T>

impl<'a, T> !UnwindSafe for StorageRead<'a, T>

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

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

type Error = Infallible

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

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

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

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

pub fn data(&self) -> &[T]ⓘNotable traits for &'_ mut [u8 ]`impl<'_> Write for &'_ mut [u8]impl<'_> Read for &'_ [u8]`

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

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

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

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

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

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