Struct Tags 

pub struct Tags(/* private fields */);

A collection of tags.

Examples

use moonshine_tag::prelude::*;

tags! { A, B };

let tags: Tags = [A, B].into();

assert_eq!(tags, [B, A]);

You may use this type on its own, or as a Component:

use bevy::prelude::*;
use moonshine_tag::prelude::*;

tags! { A, B };

let mut world = World::new();
let entity = world.spawn(Tags::from([A, B])).id();
assert_eq!(world.get::<Tags>(entity).unwrap(), [A, B]);

Implementations

impl Tags

pub fn static_empty() -> &'static Tags

A static empty set of Tags.

Usage

This is convenient for cases when the absence of Tags implies “no tags”, for example:

use bevy::prelude::*;
use moonshine_tag::prelude::*;

let mut world = World::new();

// Spawn an entity with no tags:
let entity = world.spawn_empty().id();

// Get tags, or just use the global empty set.
let tags = world.get::<Tags>(entity).unwrap_or(Tags::empty());

assert!(tags.is_empty());

pub fn new() -> Tags

Creates a new empty set of tags.

pub fn len(&self) -> usize

Returns the number of tags in this set.

pub fn is_empty(&self) -> bool

Returns true if this set is empty.

pub fn contains(&self, tag: Tag) -> bool

Returns true if this set contains the given tag.

pub fn insert(&mut self, tag: Tag) -> bool

Inserts a tag into this set.

pub fn remove(&mut self, tag: Tag) -> bool

Removes a tag from this set.

pub fn retain(&mut self, f: impl FnMut(&Tag) -> bool)

See HashSet::retain.

pub fn iter(&self) -> impl Iterator<Item = Tag>

Returns an iterator over the tags in this set.

pub fn union(self, other: impl Into<Tags>) -> Tags

Returns the union of this and another set of tags.

pub fn extend(&mut self, other: impl Into<Tags>)

Adds all tags from another set to this one.

pub fn is_disjoint(&self, tags: &Tags) -> bool

Returns true if this set has no tags in common with another set.

pub fn is_subset(&self, tags: &Tags) -> bool

Returns true if the tags in this set are all present in another set.

pub fn is_superset(&self, tags: &Tags) -> bool

Returns true if the tags in another set are all present in this set.

pub fn matches(&self, filter: &TagFilter) -> bool

Returns true if this set matches the given filter.

pub fn to_pretty_string(&self) -> String

Returns a string representation of this set of tags.

Note that this function is slow and should not be used in performance-critical code. It is mainly designed for debugging and editor purposes.

Trait Implementations

impl Clone for Tags

fn clone(&self) -> Tags

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Component for Tags

where Tags: Send + Sync + 'static,

const STORAGE_TYPE: StorageType = bevy_ecs::component::StorageType::Table

A constant indicating the storage type used for this component.

type Mutability = Mutable

A marker type to assist Bevy with determining if this component is mutable, or immutable. Mutable components will have Component<Mutability = Mutable>, while immutable components will instead have Component<Mutability = Immutable>.

fn register_required_components( _requiree: ComponentId, required_components: &mut RequiredComponentsRegistrator<'_, '_>, )

Registers required components.

fn clone_behavior() -> ComponentCloneBehavior

Called when registering this component, allowing to override clone function (or disable cloning altogether) for this component.

fn on_add() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_add ComponentHook for this Component if one is defined.

fn on_insert() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_insert ComponentHook for this Component if one is defined.

fn on_replace() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_replace ComponentHook for this Component if one is defined.

fn on_remove() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_remove ComponentHook for this Component if one is defined.

fn on_despawn() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_despawn ComponentHook for this Component if one is defined.

fn map_entities<E>(_this: &mut Self, _mapper: &mut E)

where E: EntityMapper,

Maps the entities on this component using the given EntityMapper. This is used to remap entities in contexts like scenes and entity cloning. When deriving Component, this is populated by annotating fields containing entities with #[entities]

impl Debug for Tags

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

Formats the value using the given formatter.

impl Default for Tags

fn default() -> Tags

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Tags

fn deserialize<__D>( __deserializer: __D, ) -> Result<Tags, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<const N: usize> From<[Tag; N]> for Tags

fn from(tags: [Tag; N]) -> Tags

Converts to this type from the input type.

impl From<Tag> for Tags

fn from(tag: Tag) -> Tags

Converts to this type from the input type.

impl FromIterator<Tag> for Tags

fn from_iter<T>(iter: T) -> Tags

where T: IntoIterator<Item = Tag>,

Creates a value from an iterator.

impl FromReflect for Tags

fn from_reflect(reflect: &(dyn PartialReflect + 'static)) -> Option<Tags>

Constructs a concrete instance of Self from a reflected value.

fn take_from_reflect( reflect: Box<dyn PartialReflect>, ) -> Result<Self, Box<dyn PartialReflect>>

Attempts to downcast the given value to Self using, constructing the value using from_reflect if that fails.

impl GetTypeRegistration for Tags

fn get_type_registration() -> TypeRegistration

Returns the default TypeRegistration for this type.

fn register_type_dependencies(registry: &mut TypeRegistry)

Registers other types needed by this type.

impl IntoIterator for Tags

type Item = Tag

The type of the elements being iterated over.

type IntoIter = IntoIter<<Tags as IntoIterator>::Item>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <Tags as IntoIterator>::IntoIter

Creates an iterator from a value.

impl MergeComponent for Tags

fn merge(&mut self, other: Tags)

Merges the contents of other into this Component.

impl<const N: usize> PartialEq<[Tag; N]> for &Tags

fn eq(&self, other: &[Tag; N]) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<const N: usize> PartialEq<[Tag; N]> for Tags

fn eq(&self, other: &[Tag; N]) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq for Tags

fn eq(&self, other: &Tags) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialReflect for Tags

fn get_represented_type_info(&self) -> Option<&'static TypeInfo>

Returns the TypeInfo of the type represented by this value.

fn try_apply( &mut self, value: &(dyn PartialReflect + 'static), ) -> Result<(), ApplyError>

Tries to apply a reflected value to this value.

fn reflect_kind(&self) -> ReflectKind

Returns a zero-sized enumeration of “kinds” of type.

fn reflect_ref(&self) -> ReflectRef<'_>

Returns an immutable enumeration of “kinds” of type.

fn reflect_mut(&mut self) -> ReflectMut<'_>

Returns a mutable enumeration of “kinds” of type.

fn reflect_owned(self: Box<Tags>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

fn try_into_reflect( self: Box<Tags>, ) -> Result<Box<dyn Reflect>, Box<dyn PartialReflect>>

Attempts to cast this type to a boxed, fully-reflected value.

fn try_as_reflect(&self) -> Option<&(dyn Reflect + 'static)>

Attempts to cast this type to a fully-reflected value.

fn try_as_reflect_mut(&mut self) -> Option<&mut (dyn Reflect + 'static)>

Attempts to cast this type to a mutable, fully-reflected value.

fn into_partial_reflect(self: Box<Tags>) -> Box<dyn PartialReflect>

Casts this type to a boxed, reflected value.

fn as_partial_reflect(&self) -> &(dyn PartialReflect + 'static)

Casts this type to a reflected value.

fn as_partial_reflect_mut(&mut self) -> &mut (dyn PartialReflect + 'static)

Casts this type to a mutable, reflected value.

fn reflect_partial_eq( &self, value: &(dyn PartialReflect + 'static), ) -> Option<bool>

Returns a “partial equality” comparison result.

fn reflect_clone(&self) -> Result<Box<dyn Reflect>, ReflectCloneError>

Attempts to clone Self using reflection.

fn apply(&mut self, value: &(dyn PartialReflect + 'static))

Applies a reflected value to this value.

fn to_dynamic(&self) -> Box<dyn PartialReflect>

Converts this reflected value into its dynamic representation based on its kind.

fn reflect_clone_and_take<T>(&self) -> Result<T, ReflectCloneError>

where T: 'static, Self: Sized + TypePath,

For a type implementing PartialReflect, combines reflect_clone and take in a useful fashion, automatically constructing an appropriate ReflectCloneError if the downcast fails.

fn reflect_hash(&self) -> Option<u64>

Returns a hash of the value (which includes the type).

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

Debug formatter for the value.

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl Reflect for Tags

fn into_any(self: Box<Tags>) -> Box<dyn Any>

Returns the value as a Box<dyn Any>.

fn as_any(&self) -> &(dyn Any + 'static)

Returns the value as a &dyn Any.

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Returns the value as a &mut dyn Any.

fn into_reflect(self: Box<Tags>) -> Box<dyn Reflect>

Casts this type to a boxed, fully-reflected value.

fn as_reflect(&self) -> &(dyn Reflect + 'static)

Casts this type to a fully-reflected value.

fn as_reflect_mut(&mut self) -> &mut (dyn Reflect + 'static)

Casts this type to a mutable, fully-reflected value.

fn set(&mut self, value: Box<dyn Reflect>) -> Result<(), Box<dyn Reflect>>

Performs a type-checked assignment of a reflected value to this value.

impl Serialize for Tags

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TupleStruct for Tags

fn field(&self, index: usize) -> Option<&(dyn PartialReflect + 'static)>

Returns a reference to the value of the field with index index as a &dyn Reflect.

fn field_mut( &mut self, index: usize, ) -> Option<&mut (dyn PartialReflect + 'static)>

Returns a mutable reference to the value of the field with index index as a &mut dyn Reflect.

fn field_len(&self) -> usize

Returns the number of fields in the tuple struct.

fn iter_fields(&self) -> TupleStructFieldIter<'_>

Returns an iterator over the values of the tuple struct’s fields.

fn to_dynamic_tuple_struct(&self) -> DynamicTupleStruct

Creates a new DynamicTupleStruct from this tuple struct.

fn get_represented_tuple_struct_info(&self) -> Option<&'static TupleStructInfo>

Will return None if TypeInfo is not available.

impl TypePath for Tags

fn type_path() -> &'static str

Returns the fully qualified path of the underlying type.

fn short_type_path() -> &'static str

Returns a short, pretty-print enabled path to the type.

fn type_ident() -> Option<&'static str>

Returns the name of the type, or None if it is anonymous.

fn crate_name() -> Option<&'static str>

Returns the name of the crate the type is in, or None if it is anonymous.

fn module_path() -> Option<&'static str>

Returns the path to the module the type is in, or None if it is anonymous.

impl Typed for Tags

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl Eq for Tags

impl StructuralPartialEq for Tags