Crate shipyard

Shipyard is an Entity Component System focused on usability and speed.

The user guide is a great place to learn all about Shipyard!

Features

• parallel (default) — enables workload threading and add parallel iterators
• proc (default) — re-exports macros from shipyard_proc, mainly to derive Component
• serde1 — adds (de)serialization support with serde
• std (default) — lets Shipyard use the standard library
• thread_local — adds methods and types required to work with !Send and !Sync components
• tracing — reports workload and system execution

Re-exports

• pub use crate::borrow::NonSend;
  thread_local
• pub use crate::borrow::NonSendSync;
  thread_local
• pub use crate::borrow::NonSync;
  thread_local
• pub use iter::IntoIter;
• pub use iter::IntoWithId;

Modules

• borrow
  Allows access to helper types needed to implement Borrow.
• error
  All error types.
• info
  Types for displaying workload information.
• iter
  Iterators types and traits.
• track
  module related to storage tracking, like insertion or modification.

Structs

• AllStorages
  Contains all storages present in the World.
• AllStoragesView
  Shared view over AllStorages.
• AllStoragesViewMut
  Exclusive view over AllStorages.
• BulkEntityIter
  Iterator over newly bulk added entities.
• Entities
  Entities holds the EntityIds to all entities: living, removed and dead.
• EntitiesView
  Shared view over Entities storage.
• EntitiesViewMut
  Exclusive view over Entities storage.
• EntityId
  Handle to an entity.
• Inserted
  Wrapper type allowing iterating over inserted flagged components.
• InsertedOrModified
  Wrapper type allowing iterating over inserted and modified flagged components.
• Modified
  Wrapper type allowing iterating over modified flagged components.
• Mut
  Tracks component modification.
• Not
  Used to filter out components.
• Or
  Yield the entities that have a component or another.
• Ref
  Wraps an AtomicRefcell’s shared borrow.
• RefMut
  Wraps an AtomicRefcell’s exclusive borrow.
• ScheduledWorkload
  Used to create a Workload.
• SparseArray
  Internal part of a SparseSet.
• SparseSet
  Default component storage.
• SparseSetDrain
  A draining iterator for SparseSet<T>.
• StorageMemoryUsage
  A trait to query the amount of memory a storage uses.
• TrackingTimestamp
  Timestamp used to clear tracking information.
• UniqueStorage
  Unique storage.
• UniqueView
  Shared view over a unique component storage.
• UniqueViewMut
  Exclusive view over a unique component storage.
• View
  Shared view over a component storage.
• ViewMut
  Exclusive view over a component storage.
• Workload
  Keeps information to create a workload.
• WorkloadSystem
  Self contained system that may be inserted into a Workload.
• World
  World contains all data this library will manipulate.

Enums

• Mutability
  Describes if a storage is borrowed exclusively or not.
  It is used to display workloads’ borrowing information.
• OneOfTwo
  Returned when iterating with Or filter.
• StorageId
  Id of a storage, can be a TypeId or u64.

Traits

• AddComponent
  Defines how components are added to an existing entity.
• AddDistinctComponent
  Add component only if not already present.
• AddEntity
  Trait describing how to add a new entity to a storage.
• AllStoragesBorrow
  Allows a type to be borrowed by AllStorages::borrow and AllStorages::run.
• AsLabel
  Converts a value to a Box<dyn Label>
• Borrow
  Allows a type to be borrowed by World::borrow, World::run and workloads.
• BorrowInfo
  Explains to a workload which storage are borrowed by a system.
• BulkAddEntity
  Trait used as bound for World::bulk_add_entity and AllStorages::bulk_add_entity.
• BulkReserve
  Reserves memory for a set of entities.
• Component
  Indicates that a struct or enum can be store in the World.
• Contains
  Checks if an entity has some components.
• CustomStorageAccess
  Low level access to storage.
• Delete
  Deletes component from entities.
• Get
  Retrieves components based on their type and entity id.
• IntoBorrow
  Transforms a view into a helper type. This allows workloads to have the current syntax.
• IntoWorkload
  Converts to a collection of systems.
• IntoWorkloadSystem
  Trait used to add systems to a workload.
• IntoWorkloadTrySystem
  Trait used to add fallible systems to a workload.
• Label
  Workload identifier
• Remove
  Removes component from entities.
• Storage
  Defines common storage operations.
• SystemModificator
  Modifies a system.
• TupleAddComponent
  Trait used as bound for World::add_entity, World::add_component, AllStorages::add_entity and AllStorages::add_component.
• TupleDelete
  Trait used as bound for World::delete_component and AllStorages::delete_component.
• TupleDeleteAny
  Trait used as a bound for World::delete_any and AllStorages::delete_any.
• TupleRemove
  Trait used as bound for World::remove and AllStorages::remove.
• TupleRetain
  Trait used as bound for World::retain and AllStorages::retain.
• Unique
  Indicates that a struct or enum can be store a single time in the World.
• WorkloadModificator
  Modifies a workload.

Derive Macros

• AllStoragesBorrow
• Borrow
• BorrowInfo
• Component
• Unique