Struct Entity 

pub struct Entity { /* private fields */ }

Entity datatype

Implementations

impl Entity

pub fn new( uid: EntityUID, attrs: impl IntoIterator<Item = (SmolStr, RestrictedExpr)>, indirect_ancestors: HashSet<EntityUID>, parents: HashSet<EntityUID>, tags: impl IntoIterator<Item = (SmolStr, RestrictedExpr)>, extensions: &Extensions<'_>, ) -> Result<Self, EntityAttrEvaluationError>

Create a new Entity with this UID, attributes, ancestors, and tags

Errors

• Will error if any of the [RestrictedExpr]s in attrs or tags error when evaluated

pub fn new_with_attr_partial_value( uid: EntityUID, attrs: impl IntoIterator<Item = (SmolStr, PartialValue)>, indirect_ancestors: HashSet<EntityUID>, parents: HashSet<EntityUID>, tags: impl IntoIterator<Item = (SmolStr, PartialValue)>, ) -> Self

Create a new Entity with this UID, attributes, ancestors, and tags

Unlike in Entity::new(), in this constructor, attributes and tags are expressed as PartialValue.

Callers should consider directly using [Entity::new_with_attr_partial_value_serialized_as_expr] if they would call this method by first building a map, as it will deconstruct and re-build the map perhaps unnecessarily.

pub fn uid(&self) -> &EntityUID

Get the UID of this entity

pub fn get(&self, attr: &str) -> Option<&PartialValue>

Get the value for the given attribute, or None if not present

pub fn get_tag(&self, tag: &str) -> Option<&PartialValue>

Get the value for the given tag, or None if not present

pub fn is_descendant_of(&self, e: &EntityUID) -> bool

Is this Entity a (direct or indirect) descendant of e in the entity hierarchy?

pub fn is_indirect_descendant_of(&self, e: &EntityUID) -> bool

Is this Entity a an indirect descendant of e in the entity hierarchy?

pub fn is_child_of(&self, e: &EntityUID) -> bool

Is this Entity a direct decendant (child) of e in the entity hierarchy?

pub fn ancestors(&self) -> impl Iterator<Item = &EntityUID>

Iterate over this entity’s (direct or indirect) ancestors

pub fn indirect_ancestors(&self) -> impl Iterator<Item = &EntityUID>

Iterate over this entity’s indirect ancestors

pub fn parents(&self) -> impl Iterator<Item = &EntityUID>

Iterate over this entity’s direct ancestors (parents)

pub fn attrs_len(&self) -> usize

Get the number of attributes on this entity

pub fn tags_len(&self) -> usize

Get the number of tags on this entity

pub fn keys(&self) -> impl Iterator<Item = &SmolStr>

Iterate over this entity’s attribute names

pub fn tag_keys(&self) -> impl Iterator<Item = &SmolStr>

Iterate over this entity’s tag names

pub fn attrs(&self) -> impl Iterator<Item = (&SmolStr, &PartialValue)>

Iterate over this entity’s attributes

pub fn tags(&self) -> impl Iterator<Item = (&SmolStr, &PartialValue)>

Iterate over this entity’s tags

pub fn with_uid(uid: EntityUID) -> Self

Create an Entity with the given UID, no attributes, no parents, and no tags.

pub fn deep_eq(&self, other: &Self) -> bool

Test if two Entity objects are deep/structurally equal. That is, not only do they have the same UID, but also the same attributes, attribute values, and ancestors/parents.

Does not test that they have the same direct parents, only that they have the same overall ancestor set.

pub fn add_indirect_ancestor(&mut self, uid: EntityUID)

Mark the given UID as an indirect ancestor of this Entity

The given UID will not be added as an indirecty ancestor if it is already a direct ancestor (parent) of this Entity The caller of this code is responsible for maintaining transitive closure of hierarchy.

pub fn add_parent(&mut self, uid: EntityUID)

Mark the given UID as a (direct) parent of this Entity, and remove the UID from indirect ancestors if it was previously added as an indirect ancestor The caller of this code is responsible for maintaining transitive closure of hierarchy.

pub fn remove_indirect_ancestor(&mut self, uid: &EntityUID)

Remove the given UID as an indirect ancestor of this Entity.

No effect if the UID is a direct parent. The caller of this code is responsible for maintaining transitive closure of hierarchy.

pub fn remove_parent(&mut self, uid: &EntityUID)

Remove the given UID as a (direct) parent of this Entity.

No effect on the Entity’s indirect ancestors. The caller of this code is responsible for maintaining transitive closure of hierarchy.

pub fn remove_all_indirect_ancestors(&mut self)

Remove all indirect ancestors of this Entity.

The caller of this code is responsible for maintaining transitive closure of hierarchy.

pub fn into_inner( self, ) -> (EntityUID, HashMap<SmolStr, PartialValue>, HashSet<EntityUID>, HashSet<EntityUID>, HashMap<SmolStr, PartialValue>)

Consume the entity and return the entity’s owned Uid, attributes, ancestors, parents, and tags.

pub fn write_to_json(&self, f: impl Write) -> Result<(), EntitiesError>

Write the entity to a json document

pub fn to_json_value(&self) -> Result<Value, EntitiesError>

write the entity to a json value

pub fn to_json_string(&self) -> Result<String, EntitiesError>

write the entity to a json string

Trait Implementations

impl Clone for Entity

fn clone(&self) -> Entity

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Entity

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

Formats the value using the given formatter.

impl Display for Entity

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

Formats the value using the given formatter.

impl Hash for Entity

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 PartialEq for Entity

Entitys are equal if their UIDs are equal

fn eq(&self, other: &Self) -> 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 StaticallyTyped for Entity

fn type_of(&self) -> Type

Get the object’s type

impl TCNode<EntityUID> for Entity

fn get_key(&self) -> EntityUID

Extract a unique identifier for the node.

fn add_edge_to(&mut self, k: EntityUID)

Add an edge out off this node to the node with key k.

fn out_edges(&self) -> Box<dyn Iterator<Item = &EntityUID> + '_>

Retrieve an iterator for the edges out of this node.

fn has_edge_to(&self, e: &EntityUID) -> bool

Return true when their is an edge between this node and the node with key k.

fn reset_edges(&mut self)

Resets edges to base

fn direct_edges(&self) -> Box<dyn Iterator<Item = &EntityUID> + '_>

Retrieves an iterator for direct edges out of this node.

impl Eq for Entity