my_ecs

Module prelude

Source
Expand description

Imports all you need at once.

Re-exports§

pub use super::global;
pub use super::ds::prelude::*;

Modules§

str_util
String utilities.

Macros§

filter
Implements Filter for the type, and implements Select optionally if Target is defined.
log
Prints out the given string regardless of build target.
request
Implements Request for the type.
tinfo
Creates TypeInfo from the given type and reflects whether the type implements Send, Sync, Default, and Clone to the TypeInfo.

Structs§

ChunkSparseSet
Two-dimensional storage containing heterogeneous data types based on ChunkAnyVec.
Commander
Ecs
A handle to EcsApp, which is real ecs instance.
EcsApp
An ECS instance.
EcsExt
Extended Ecs with additional methods.
EcsPar
A wrapper type of Rayon’s parallel iterator.
EntWrite
Write request for a set of entity container.
EntityId
A specific entity identifier.
EntityIndex
Index to a specific entity container.
EntityName
Unique entity name.
EntityReg
A descriptor for registration of an entity storage.
FnOnceSystem
A system that is FnOnce.
FnSystem
A system that is FnMut.
LeakedEcsApp
A handle to an EcsApp.
Post
A Resource to send command or future.
PowerOfTwo
A type representing 2^k usize.
Read
Read request for a set of components.
ResRead
Read request for a set of resources.
ResWrite
Write request for a set of resources.
ResourceDesc
A descriptor for registration of a resource.
ResourceId
A unique identifier for a resource item.
ResourceIndex
A unique resource identifier.
Response
A response corresponding to a Request.
SparseSet
Two-dimensional storage containing heterogeneous data types based on AnyVec.
SubContext
Context for a sub worker.
SystemBond
A internal type for support flexible APIs.
SystemDesc
A descriptor for a System.
SystemId
Unique system identifier consisting of group index and system index.
With
A value with another value.
Worker
Worker handle.
WorkerBuilder
Worker builder.
WorkerPool
A data type holding Workers.
Write
Write request for a set of components.

Enums§

EcsError
An error generated by ECS instance.
InsertPos
A position to insert a system into system scheduling list.
Or
A type that either A or B.
SystemState
State of a system.

Traits§

AddEntity
A trait for adding or removing component values from an entity container.
AsEntityReg
A trait for generating EntityReg.
AsWorkerPool
Common interface for worker pool implementations.
BorrowComponent
A trait for borrowing a component column from an entity container.
Command
Command to an ECS instance.
Component
Ordinary rust types.
Components
A set of Components.
ContainEntity
A trait for collecting heterogeneous component types.
EcsEntry
Common interafaces that ECS instance should provide to clients.
Entity
A set of components.
Filter
A trait for selecting certain entities that meet All, Any, and None conditions.
FromParallelIterator
FromParallelIterator implements the creation of a collection from a ParallelIterator. By implementing FromParallelIterator for a given type, you define how it will be created from an iterator.
HelpExecuteManyCommands
A helper trait for EcsEntry::execute_commands.
IndexedParallelIterator
An iterator that supports “random access” to its data, meaning that you can split it at arbitrary indices and draw data from those points.
IntoEcsPar
A trait for wrapping Rayon’s parallel iterators in EcsPar in order to intercept function call to a Rayon API then to execute them in the ECS context.
IntoParallelIterator
IntoParallelIterator implements the conversion to a ParallelIterator.
IntoParallelRefIterator
IntoParallelRefIterator implements the conversion to a ParallelIterator, providing shared references to the data.
IntoParallelRefMutIterator
IntoParallelRefMutIterator implements the conversion to a ParallelIterator, providing mutable references to the data.
ParallelBridge
Conversion trait to convert an Iterator to a ParallelIterator.
ParallelDrainFull
ParallelDrainFull creates a parallel iterator that moves all items from a collection while retaining the original capacity.
ParallelDrainRange
ParallelDrainRange creates a parallel iterator that moves a range of items from a collection while retaining the original capacity.
ParallelExtend
ParallelExtend extends an existing collection with items from a ParallelIterator.
ParallelIterator
Parallel version of the standard iterator trait.
ParallelSlice
Parallel extensions for slices.
ParallelSliceMut
Parallel extensions for mutable slices.
ParallelString
Parallel extensions for strings.
RegisterComponent
A trait for adding or removing component types from an entity container.
Request
A system request for a components, resources, and entity containers.
Resource
Unique data in the entire ecs instance.
Select
A trait for selecting a certain Target from entities that meet All, Any, and None conditions.
System
System is a type that accesses components, entities, or resoruces.
TakeRecur
A trait for taking inner value out.
Work
A trait for worker.

Type Aliases§

ComponentKey
Unique identifier for a type implementing Component.
DynResult
A Result with super flexible error type Box<dyn Error + Send + Sync + 'static>.
Tick
Monotonically increasing count over scheduling.
WithResult
A value with Result.

Derive Macros§

Component
Implements Component for the type.
Entity
Impelments Entity for the type.
Resource
Implements Resource for the type.