Struct EntityInstance

pub struct EntityInstance {
    pub ty: EntityTypeId,
    pub id: Uuid,
    pub name: String,
    pub description: String,
    pub properties: PropertyInstances,
    pub components: ComponentTypeIds,
    pub extensions: Extensions,
}

Entity instances represents an typed object which contains properties.

The entity type defines the properties (name, data type and socket type).

In contrast to the entity type the entity instance stores values in its properties.

Fields

ty: EntityTypeId

The type definition of the entity type.

id: Uuid

The unique identifier of the entity instance.

name: String

The name of the entity instance.

description: String

The description of the entity instance.

properties: PropertyInstances

The properties of the entity instance.

Each property is represented by its name (String) and it’s value. The value is a representation of a JSON. Therefore, the value can be boolean, number, string, array or an object. For more information about the data types please look at https://docs.serde.rs/serde_json/value/enum.Value.html

components: ComponentTypeIds

The components of the entity instance.

extensions: Extensions

Entity instance specific extensions.

Implementations

impl EntityInstance

pub fn builder() -> EntityInstanceBuilder<((), (), (), (), (), (), ())>

Create a builder for building EntityInstance. On the builder, call .ty(...), .id(...)(optional), .name(...)(optional), .description(...)(optional), .properties(...)(optional), .components(...)(optional), .extensions(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of EntityInstance.

impl EntityInstance

pub fn new<T: Into<EntityTypeId>, P: Into<PropertyInstances>>( ty: T, id: Uuid, properties: P, ) -> EntityInstance

Constructs a new entity instance with the given type.

pub fn new_from_type<N: Into<String>, T: Into<String>, P: Into<PropertyInstances>>( namespace: N, type_name: T, id: Uuid, properties: P, ) -> EntityInstance

Constructs a new entity instance with the given namespace, type_name, id and properties.

pub fn new_without_properties<T: Into<EntityTypeId>>( ty: T, id: Uuid, ) -> EntityInstance

Constructs a new entity instance with the given type and id but without properties.

Trait Implementations

impl Clone for EntityInstance

fn clone(&self) -> EntityInstance

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ComponentTypeIdContainer for EntityInstance

fn is_a(&self, ty: &ComponentTypeId) -> bool

Returns true, if the type is composed with a component of the given type.

fn add_component<C: Into<ComponentTypeId>>(&self, ty: C) -> bool

Adds the given component.

fn add_components<C: Into<ComponentTypeIds>>(&mut self, components_to_add: C)

Adds the given components.

fn remove_component(&self, ty: &ComponentTypeId) -> Option<ComponentTypeId>

Removes the component with the given type id.

fn remove_components<C: Into<ComponentTypeIds>>( &mut self, components_to_remove: C, )

Removes the given components.

fn is_any(&self, component_tys: &ComponentTypeIds) -> bool

Returns true, if the type is composed with any of the given components.

fn is_all(&self, component_tys: &ComponentTypeIds) -> bool

Returns true, if the type is composed with every given components.

impl Debug for EntityInstance

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for EntityInstance

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for EntityInstance

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

Formats the value using the given formatter.

impl ExtensionContainer for EntityInstance

fn has_own_extension(&self, ty: &ExtensionTypeId) -> bool

Returns true, if the container has an extension with the given type.

fn get_own_extension(&self, ty: &ExtensionTypeId) -> Option<Extension>

Returns the own extension with the given type. Doesn’t respect extensions from potential components.

fn add_extension<E: Into<Extension>>( &self, extension: E, ) -> Result<ExtensionTypeId, AddExtensionError>

fn update_extension<T: Into<ExtensionTypeId>, E: Into<Extension>>( &self, ty: T, extension: E, ) -> Result<Extension, UpdateExtensionError>

fn remove_extension<T: Into<ExtensionTypeId>>( &self, ty: T, ) -> Result<Extension, RemoveExtensionError>

fn merge_extensions<E: Into<Extensions>>(&mut self, extensions_to_merge: E)

Merge the given extensions into the own extensions.

fn has_any_own_extensions(&self, tys: &ExtensionTypeIds) -> bool

Returns true, if the type contains any of the given extensions.

fn has_all_own_extensions(&self, tys: &ExtensionTypeIds) -> bool

Returns true, if the type contains all given extensions.

impl From<EntityInstance> for FlowInstance

fn from(wrapper_entity_instance: EntityInstance) -> FlowInstance

Converts to this type from the input type.

impl FromIterator<EntityInstance> for EntityInstances

fn from_iter<I: IntoIterator<Item = EntityInstance>>(iter: I) -> Self

Creates a value from an iterator.

impl Hash for EntityInstance

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl JsonSchema for EntityInstance

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

fn always_inline_schema() -> bool

👎Deprecated: Use inline_schema() instead

Only included for backward-compatibility - use inline_schema() instead“.

impl MutablePropertyInstanceSetter for EntityInstance

fn set<S: Into<String>>(&mut self, property_name: S, value: Value)

Sets the value of the given property by name

impl NamedInstanceContainer for EntityInstance

fn name(&self) -> String

Returns the name of the instance.

fn description(&self) -> String

Returns the description of the instance.

impl NamespacedTypeGetter for EntityInstance

fn namespace(&self) -> String

Returns the namespace of the type.

fn type_name(&self) -> String

Returns the name of the type.

impl Ord for EntityInstance

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq<Uuid> for EntityInstance

fn eq(&self, id: &Uuid) -> 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 EntityInstance

fn eq(&self, other: &EntityInstance) -> 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 PartialOrd for EntityInstance

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl PropertyInstanceGetter for EntityInstance

fn get<S: Into<String>>(&self, property_name: S) -> Option<Value>

Returns the json value of the given property by name

fn as_bool<S: Into<String>>(&self, property_name: S) -> Option<bool>

Returns the boolean value of the given property by name

fn as_u64<S: Into<String>>(&self, property_name: S) -> Option<u64>

Returns the u64 value of the given property by name

fn as_i64<S: Into<String>>(&self, property_name: S) -> Option<i64>

Returns the i64 value of the given property by name

fn as_f64<S: Into<String>>(&self, property_name: S) -> Option<f64>

Returns the f64 value of the given property by name

fn as_string<S: Into<String>>(&self, property_name: S) -> Option<String>

Returns the string value of the given property by name

fn as_array<S: Into<String>>(&self, property_name: S) -> Option<Vec<Value>>

Returns the string value of the given property by name

fn as_object<S: Into<String>>( &self, property_name: S, ) -> Option<Map<String, Value>>

Returns the string value of the given property by name

impl Serialize for EntityInstance

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TypeDefinitionGetter for EntityInstance

fn type_definition(&self) -> TypeDefinition

Returns the type definition of the type.

impl Eq for EntityInstance

impl StructuralPartialEq for EntityInstance