Struct EntityReference 

pub struct EntityReference {
    pub type: String,
    pub entity: EntityId,
    pub entity_type: Option<EntityType>,
    pub name: Option<String>,
    pub role: Option<String>,
}

Closed pointer to an entity mentioned by a MIF memory.

Corresponds to schema/definitions/entity-reference.schema.json. See EntityData for the open-payload counterpart used when a memory is an entity, rather than merely mentioning one.

Fields

type: String

JSON-LD type marker. Always "EntityReference".

entity: EntityId

The entity’s identifier.

entity_type: Option<EntityType>

Entity type classification.

name: Option<String>

Display name for the entity.

role: Option<String>

Role of the entity in the memory context (e.g. author, subject, topic).

Implementations

impl EntityReference

pub fn new(id: String) -> Self

Creates a new reference to the entity identified by id (e.g. urn:mif:entity:person:jane-smith).

pub fn with_entity_type(self, entity_type: EntityType) -> Self

Sets the entity type classification.

pub fn with_name(self, name: String) -> Self

Sets the display name.

pub fn with_role(self, role: String) -> Self

Sets the entity’s role in the memory context.

Trait Implementations

impl Clone for EntityReference

fn clone(&self) -> EntityReference

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EntityReference

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for EntityReference

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for EntityReference

impl PartialEq for EntityReference

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for EntityReference