Struct Entity

pub struct Entity { /* private fields */ }

Entity datatype

Implementations

impl Entity

pub fn new( uid: EntityUID, attrs: impl IntoIterator<Item = (SmolStr, RestrictedExpr)>, ancestors: 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)>, ancestors: HashSet<EntityUID>, ) -> Self

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

Unlike in Entity::new(), in this constructor, attributes 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 new_with_attr_partial_value_serialized_as_expr( uid: EntityUID, attrs: BTreeMap<SmolStr, PartialValueSerializedAsExpr>, ancestors: HashSet<EntityUID>, ) -> Self

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

Unlike in Entity::new(), in this constructor, attributes are expressed as PartialValueSerializedAsExpr.

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 descendant of e in the entity hierarchy?

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

Iterate over this entity’s ancestors

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 into_inner( self, ) -> (EntityUID, HashMap<SmolStr, PartialValue>, HashSet<EntityUID>, HashMap<SmolStr, PartialValue>)

Consume the entity and return the entity’s owned Uid, attributes, 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 copy 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

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

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.

impl Eq for Entity