Module prelude

Module prelude 

Source

Re-exports§

pub use crate::context::Context;
pub use crate::entity::events::EntityCreatedEvent;
pub use crate::entity::events::PropertyChangeEvent;
pub use crate::entity::property::Property;
pub use crate::entity::ContextEntitiesExt;
pub use crate::entity::Entity;
pub use crate::entity::EntityId;
pub use crate::error::IxaError;
pub use crate::global_properties::ContextGlobalPropertiesExt;
pub use crate::network::ContextNetworkExt;
pub use crate::random::ContextRandomExt;
pub use crate::report::ContextReportExt;
pub use crate::PluginContext;

Macros§

debug
Logs a message at the debug level.
define_data_plugin
Defines a new type for storing data in Context.
define_derived_property
The “derived” variant of define_property! for defining simple derived property types. Defines a struct or enum with a standard set of derives and automatically invokes impl_derived_property! for it.
define_edge_type
define_entity
Defines a zero-sized struct with the right derived traits and implements the Entity trait. If you already have a type defined (struct, enum, etc.), you can use the impl_entity! macro instead.
define_global_property
Defines a global property with the following parameters:
define_multi_property
Defines a derived property consisting of a (named) tuple of other properties. The primary use case is for indexing and querying properties jointly.
define_property
Defines a struct or enum with a standard set of derives and automatically invokes impl_property! for it. This macro provides a concise shorthand for defining simple property types that follow the same derive and implementation pattern.
define_report
Use this macro to define a unique report type
define_rng
Use this to define a unique type which will be used as a key to retrieve an independent rng instance when calling Context::get_rng.
error
Logs a message at the error level.
impl_edge_type
impl_entity
Implements the Entity trait for the given existing type and defines a type alias of the form MyEntityId = EntityId<MyEntity>. For simple zero-sized types, use the define_entity! macro instead, which will define the struct and derive all the super traits.
impl_property
Implements the Property trait for the given property type and entity.
info
Logs a message at the info level.
trace
Logs a message at the trace level.
warn
Logs a message at the warn level.