Struct CommitContext 

pub struct CommitContext<'a> {
    pub actor: Actor,
    pub client: Option<ClientId>,
    pub tool: Option<&'a str>,
    pub note: Option<String>,
    pub logical_operation_id: Option<&'a str>,
    pub entity_ids: Option<Vec<String>>,
}

Provenance bundle for a single commit. Produced at the caller boundary (memstead-mcp tool handler, memstead-cli subcommand, engine-internal drift flush) and threaded through to the VCS commit path.

Fields

actor: Actor

client: Option<ClientId>

tool: Option<&'a str>

Name of the MCP tool that initiated the commit (e.g. "memstead_update"). Present for MCP-sourced commits; CLI-direct and external-drift commits leave this None.

note: Option<String>

Agent-authored one-sentence provenance note. When present and non-empty it lands in the commit body between the caller’s prose and the Tool:/Actor:/Client: trailer block. Whitespace-only values are treated as absent. The MCP layer validates length (NOTE_MAX_LEN, 280 chars) before the mutation touches disk; callers must not feed unbounded input to this field.

logical_operation_id: Option<&'a str>

Correlation id linking every commit produced by a single logical operation (notably multi-mem memstead_rename). When Some, format_commit_message emits a Logical-Op: <id> trailer alongside Tool: / Actor: / Client:. The git- branch backend’s parse_commit_message recovers the value from the trailer block so read_provenance reconstructs Provenance::logical_operation_id round-trip-clean. None for legacy or single-call mutations that don’t participate in correlation; consumers branch on whether the id recurs to identify a multi-commit logical operation.

entity_ids: Option<Vec<String>>

Entity ids this commit touched, when one commit covers more than one entity (notably batch_update, whose subject collapses to (N entities)). When Some and non-empty, format_commit_message emits an Entities: id1, id2, … trailer that parse_commit_message recovers into CommitNote::entity_ids, so an --include-notes consumer can name every entity a batch changed from the note record alone. None/empty for single-entity commits — those name their one id in the subject (and thus entity_id), so no list is needed.

Implementations

impl<'a> CommitContext<'a>

pub fn internal() -> CommitContext<'a>

Author-neutral context: no actor, no client, no tool. The author signature falls back to the committer identity — preserving the pre-provenance behaviour. Used by engine tests and by call sites that have not yet been taught to build a real context.

Trait Implementations

impl<'a> Clone for CommitContext<'a>

fn clone(&self) -> CommitContext<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for CommitContext<'a>

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

Formats the value using the given formatter.