Struct DatabaseQuery

pub struct DatabaseQuery<'world, 'state, Q: DBQueryInfo<DbResource>, DbResource: DatabaseResource> { /* private fields */ }

Implementations

impl<'w, 's, Q: DBQueryInfo<DbResource>, DbResource: DatabaseResource> DatabaseQuery<'w, 's, Q, DbResource>

pub async fn get<D: DatabaseEntityWithRequest>( &self, db_entity: &D, ) -> Result<Q::ReadOnlyItem<'w>, ()>

pub async fn get_mut<D: DatabaseEntityWithRequest>( &self, db_entity: &D, ) -> Result<Q::Item<'w>, ()>

pub async fn update_component( &self, db_entity: &DatabaseEntity, component: Q::ReadOnlyItem<'w>, ) -> Result<(), ()>

pub async fn insert_component( &self, db_entity: &DatabaseEntity, component: Q::ReadOnlyItem<'w>, ) -> Result<(), ()>

pub async fn load_components<R: ReturnSelector<'w>, CDQ>( &self, request: RequestId, get_comp_from_db: CDQ, ) -> Result<Vec<<R as ReturnSelector<'w>>::ReturnItem>, ()>

where CDQ: CustomDatabaseQuery<DbResource, Q::DerefItem> + Send,

pub async fn create( &self, component: Q::DerefItem, request: RequestId, ) -> Result<(), ()>

pub async fn update_or_insert_component(&self, entity: Entity) -> Result<(), ()>

pub fn commit(&self, request: RequestId) -> Result<(), ()>

Trait Implementations

impl<'w, 's, I, DbResource: DatabaseResource> SystemParam for DatabaseQuery<'w, 's, I, DbResource>

where I: DBQueryInfo<DbResource> + 'static,

type State = QueryFetchState<'static, 'static, DbResource>

Used to store data which persists across invocations of a system.

type Item<'world, 'state> = DatabaseQuery<'world, 'state, I, DbResource>

The item type returned when constructing this system param. The value of this associated type should be Self, instantiated with new lifetimes.

fn init_state(world: &mut World, system_meta: &mut SystemMeta) -> Self::State

Registers any World access used by this SystemParam and creates a new instance of this param’s State.

unsafe fn get_param<'w2, 's2>( state: &'s2 mut Self::State, system_meta: &SystemMeta, world: UnsafeWorldCell<'w2>, change_tick: Tick, ) -> Self::Item<'w2, 's2>

Creates a parameter to be passed into a SystemParamFunction.

fn new_archetype( _state: &mut Self::State, _archetype: &Archetype, _system_meta: &mut SystemMeta, )

For the specified Archetype, registers the components accessed by this SystemParam (if applicable).

fn apply(state: &mut Self::State, system_meta: &SystemMeta, world: &mut World)

Applies any deferred mutations stored in this SystemParam’s state. This is used to apply Commands during apply_deferred.