Struct Entity 

pub struct Entity {
    pub id: EntityId,
    pub title: String,
    pub entity_type: String,
    pub mem: String,
    pub file_path: String,
    pub metadata: IndexMap<String, MetadataValue>,
    pub sections: IndexMap<String, String>,
    pub relationships: Vec<Relationship>,
    pub content_hash: String,
    pub stub: bool,
    pub stub_kind: Option<StubKind>,
    pub heading_spans: HashMap<String, Vec<HeadingSpan>>,
}

A parsed entity with metadata, sections, and relationships.

Fields

id: EntityId

title: String

entity_type: String

mem: String

file_path: String

metadata: IndexMap<String, MetadataValue>

Frontmatter metadata. Ordered (IndexMap) so iteration preserves the YAML key order the parser saw — required for deterministic rendering by render::render_entity_markdown, which iterates this map directly.

sections: IndexMap<String, String>

Section keys map to raw content. Ordered (IndexMap) so iteration yields sections in the order the parser inserted them — today that matches the schema’s declared order, which is what renderers rely on for deterministic output.

relationships: Vec<Relationship>

content_hash: String

SHA-256 hash of the raw markdown content for optimistic locking.

stub: bool

True if this is a stub entity (created from an unresolved reference). Tracks stub_kind.is_some() and is preserved for compatibility with readers that don’t need the typed provenance. New code branches on Self::stub_kind when the origin matters (ForwardReference / LoadTime / Residual).

stub_kind: Option<StubKind>

Typed stub provenance — set at stub creation and persists for the engine instance’s lifetime. None for real (non-stub) entities; Some(kind) matches stub == true by construction (every make_stub site sets both fields atomically). See StubKind for the variant semantics and lifecycle rules.

heading_spans: HashMap<String, Vec<HeadingSpan>>

Per-H2-section H3–H6 heading spans — a derived parse artefact used by search to attach heading_path to per-term matches. Keyed by H2 section key; value lists spans in document order with byte offsets into the raw section content. Regenerated on every parse; never written back to markdown, never hashed, never round-tripped. The in-memory graph stays flat — sub-sections are search-only metadata.

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<(), Error>

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Entity

fn deserialize<__D>( __deserializer: __D, ) -> Result<Entity, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Entity

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

where __S: Serializer,

Serialize this value into the given Serde serializer.