Struct UpdateEntityOutcome 

pub struct UpdateEntityOutcome {
    pub id: EntityId,
    pub title: String,
    pub file_path: String,
    pub content_hash: String,
    pub commit_sha: String,
    pub modified_date: String,
    pub modified_sections: ModifiedSections,
    pub modified_metadata: ModifiedMetadata,
    pub prospective_hash: Option<String>,
    pub orphan_stubs_removed: Vec<EntityId>,
    pub warnings: Vec<WarningHint>,
    pub relations_declared: Vec<RelationDeclared>,
}

Successful outcome of [Engine::update_entity].

Fields

id: EntityId

title: String

Title from the parsed entity after the write — wire-equivalent to full’s UpdateResult.title. Reflects post-write state in case a future update path touches the title (today the update surface doesn’t, but reading from the parsed entity rather than echoing args keeps the field correct as the surface evolves).

file_path: String

content_hash: String

Wire key _hash.

commit_sha: String

Per-mem commit identifier returned by the backend’s crate::backend::MemBackend::commit. Wire-equivalent to full’s UpdateResult.commit_sha.

modified_date: String

ISO date string from the parsed entity’s modified_date metadata. Populated when the schema auto-stamps the field on update; empty when the schema doesn’t declare it. Wire- equivalent to full’s UpdateResult.modified_date.

modified_sections: ModifiedSections

Section-level mutations grouped by mode (replaced / appended / patched). Wire-equivalent to full’s UpdateResult.modified_sections. Empty inner vecs serde-omit per ModifiedSections’s field attributes; the outer key is always present.

modified_metadata: ModifiedMetadata

Metadata-level mutations grouped by direction (set / unset). Wire-equivalent to full’s UpdateResult.modified_metadata. Same empty-vec-omit convention as modified_sections.

prospective_hash: Option<String>

Some(hash) on the dry_run path — the hash the entity would have after the proposed write. None on real updates (the post-write hash is in content_hash). Wire-equivalent to full’s UpdateResult.prospective_hash.

orphan_stubs_removed: Vec<EntityId>

Stub entities whose last incoming edge was severed by this update — when a body wiki-link was removed, the alias-resync drops the backing pointer-rel-type edge, and if that was the stub target’s last referrer the stub is GC’d here. Empty on updates that didn’t orphan a stub (including section edits with no wiki-link change, dry-run, and no-op). Shares the field name and always-present shape with DeleteEntityOutcome::orphan_stubs_removed and RelateEntityOutcome::orphan_stubs_removed so MCP / CLI consumers branch uniformly across the three GC paths.

warnings: Vec<WarningHint>

Typed non-fatal issues — empty on the unified path today (update doesn’t surface InlineWikiLinkAutoStubbed or MissingRequiredOutgoing yet). Wire-equivalent to full’s UpdateResult.warnings; the field shape parity matters for the upcoming handler migration so callers see the same warnings: [] envelope position across flavours.

relations_declared: Vec<RelationDeclared>

Batched relation declarations applied by this call (per the optional declare_relations request param). Empty [] when no batched declarations were requested; populated with one entry per declared relation otherwise. target_was_stubbed flags which targets were absent at call time and got auto-stubbed; agents use this to skip a follow-up memstead_entity round-trip on the stubbed target.

Trait Implementations

impl Clone for UpdateEntityOutcome

fn clone(&self) -> UpdateEntityOutcome

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UpdateEntityOutcome

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

Formats the value using the given formatter.

impl Serialize for UpdateEntityOutcome

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

where __S: Serializer,

Serialize this value into the given Serde serializer.