Struct EntityRef 

pub struct EntityRef {
    pub id: EntityId,
    pub display: String,
    pub aliases: Vec<String>,
}

A reference to the subject of a memory.

Fields

id: EntityId

Stable identifier, normalized from the display name when unknown.

display: String

How the user refers to this entity.

aliases: Vec<String>

Alternative names (“wife”, “Rhea”, “my partner”).

Implementations

impl EntityRef

pub fn user() -> Self

The user themselves — the subject of most memories.

pub fn named(display: impl Into<String>) -> Self

A named third party, with the id derived from the normalized name.

pub fn with_alias(self, alias: impl Into<String>) -> Self

Add an alias, returning the modified reference.

pub fn surface_forms(&self) -> Vec<String>

Every surface form this entity can be matched by, normalized.

Trait Implementations

impl Clone for EntityRef

fn clone(&self) -> EntityRef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EntityRef

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for EntityRef

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for EntityRef

fn schema_name() -> String

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 is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl PartialEq for EntityRef

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

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 EntityRef