Struct all_is_cubes::behavior::BehaviorSet

pub struct BehaviorSet<H: BehaviorHost> { /* private fields */ }

Collects Behaviors and invokes them.

Note: This type is public out of necessity because it is revealed elsewhere, but its details are currently subject to change.

To modify the set, use a BehaviorSetTransaction.

Serialization stability warning

This type implements serde::Serialize and serde::Deserialize, but serialization support is still experimental (as is the game data model in general). We do not guarantee that future versions of all-is-cubes will be able to deserialize data which is serialized by this version.

Additionally, the serialization schema is designed with serde_json in mind. It is not guaranteed that using a different data format crate, which may use a different subset of the information exposed via serde::Serialize, will produce stable results.

Implementations

impl<H: BehaviorHost> BehaviorSet<H>

pub fn new() -> Self

Constructs an empty BehaviorSet.

pub fn query<T: Behavior<H>>( &self, ) -> impl Iterator<Item = QueryItem<'_, H, T>> + '_

Find behaviors of a specified type.

The behaviors will be returned in a deterministic order. In the current implementation, that order is the order in which they were added.

TODO: Allow querying by attachment details (spatial, etc)

pub fn query_any<'a>( &'a self, type_filter: Option<TypeId>, ) -> impl Iterator<Item = QueryItem<'a, H, dyn Behavior<H> + 'static>> + 'a

Find behaviors by filter criteria. All Nones mean “anything”.

The behaviors will be returned in a deterministic order. In the current implementation, that order is the order in which they were added.

TODO: Allow querying by attachment details (spatial, etc)

Trait Implementations

impl<H: BehaviorHost> Clone for BehaviorSet<H>

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<H: BehaviorHost> Debug for BehaviorSet<H>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<H: BehaviorHost> Default for BehaviorSet<H>

fn default() -> Self

Returns the “default value” for a type.

impl<'de, H> Deserialize<'de> for BehaviorSet<H>

where H: BehaviorHost<Attachment: DeserializeOwned>,

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl<H> Serialize for BehaviorSet<H>

where H: BehaviorHost<Attachment: Serialize>,

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl<H: BehaviorHost> Transactional for BehaviorSet<H>

type Transaction = BehaviorSetTransaction<H>

The type of transaction which should be used with Self.

impl<H: BehaviorHost> VisitHandles for BehaviorSet<H>

fn visit_handles(&self, visitor: &mut dyn HandleVisitor)

For each Handle contained within self that is reachable without traversing another Handle, call visitor with a reference to it.