bevy_mod_index 0.9.0

Allows using indexes to efficiently query for components by their values in the game engine Bevy.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

//! A crate that allows using indexes to efficiently query for components
//! by their values in the game engine Bevy.
//!
//! To use indexes, include the [`Index`][crate::index::Index]
//! [`SystemParam`](bevy::ecs::system::SystemParam) as an argument to your systems.
//! [`Index`][crate::index::Index] is generic over [`IndexInfo`][crate::index::IndexInfo], which is
//! a trait that you must implement on your own types to define the behavior of the index.

#![warn(missing_docs)]
#![deny(unsafe_op_in_unsafe_fn)]
#![allow(clippy::needless_lifetimes)]

/// Main index logic.
pub mod index;

/// Various types of storage for maintaining indexes.
pub mod storage;

/// Policy definitions and utilities for automatically refreshing indexes.
pub mod refresh_policy;

mod unique_multimap;

/// Commonly used types.
pub mod prelude {
    pub use crate::index::{Index, IndexInfo};
    pub use crate::refresh_policy::*;
    pub use crate::storage::{HashmapStorage, IndexStorage, NoStorage};
}