pub struct ToolInvocation { /* private fields */ }Expand description
One immutable, journal-anchored revision of a logical tool invocation.
Deserialization verifies the record’s local checksums, scope, provenance,
limits, and predecessor-head shape. To prove retry policy and the complete
state history, stream every revision in ascending order through
ToolInvocationHistoryVerifier.
Implementations§
Source§impl ToolInvocation
impl ToolInvocation
Sourcepub fn prepare(
intent: ToolInvocationIntent,
journal_head: JournalHead,
) -> Result<Self, ToolInvocationError>
pub fn prepare( intent: ToolInvocationIntent, journal_head: JournalHead, ) -> Result<Self, ToolInvocationError>
Materializes the initial prepared revision after its journal event commits.
The supplied journal head must belong to the activation’s tenant/run and strictly advance the base checkpoint journal sequence without regressing its durable clock.
§Errors
Returns ToolInvocationError for scope, ordering, or integrity failure.
Sourcepub fn advance(
&self,
transition: ToolInvocationTransition,
journal_head: JournalHead,
) -> Result<Self, ToolInvocationError>
pub fn advance( &self, transition: ToolInvocationTransition, journal_head: JournalHead, ) -> Result<Self, ToolInvocationError>
Applies one legal transition and constructs its next immutable revision.
This method enforces state legality, exact attempt provenance, descriptor
and effective limits, external-effect retry safety, minimum retry delay,
journal scope/order, and revision overflow. Stores must still compare
Self::head under the run lock and current fencing token.
§Errors
Returns ToolInvocationError when the transition cannot safely commit.
Sourcepub fn restore(
intent: ToolInvocationIntent,
revision: ToolInvocationRevision,
state: ToolInvocationState,
previous: Option<ToolInvocationHead>,
journal_head: JournalHead,
transition: Option<ToolInvocationTransition>,
transition_digest: Option<Digest>,
digest: Digest,
) -> Result<Self, ToolInvocationError>
pub fn restore( intent: ToolInvocationIntent, revision: ToolInvocationRevision, state: ToolInvocationState, previous: Option<ToolInvocationHead>, journal_head: JournalHead, transition: Option<ToolInvocationTransition>, transition_digest: Option<Digest>, digest: Digest, ) -> Result<Self, ToolInvocationError>
Restores a record and verifies all invariants available in that revision.
Failed-to-executing retry authorization depends on the predecessor’s full
failure payload and is therefore verified by
ToolInvocationHistoryVerifier, not by a compact predecessor head.
§Errors
Returns ToolInvocationError for malformed state, provenance, scope,
ordering, transition checksum, or record checksum.
Sourcepub const fn intent(&self) -> &ToolInvocationIntent
pub const fn intent(&self) -> &ToolInvocationIntent
Returns the immutable preparation intent.
Sourcepub const fn revision(&self) -> ToolInvocationRevision
pub const fn revision(&self) -> ToolInvocationRevision
Returns this record’s monotonic revision.
Sourcepub const fn state(&self) -> &ToolInvocationState
pub const fn state(&self) -> &ToolInvocationState
Returns the integrity-bound lifecycle state.
Sourcepub const fn status(&self) -> ToolInvocationStatus
pub const fn status(&self) -> ToolInvocationStatus
Returns the lifecycle discriminator.
Sourcepub const fn attempt_id(&self) -> Option<AttemptId>
pub const fn attempt_id(&self) -> Option<AttemptId>
Returns the physical attempt represented by this revision, if any.
Sourcepub fn validate_reconciliation_result(
&self,
result: &ToolResult,
) -> Result<(), ToolInvocationError>
pub fn validate_reconciliation_result( &self, result: &ToolResult, ) -> Result<(), ToolInvocationError>
Validates authoritative success evidence for this invocation’s unknown attempt.
This performs the same invocation, attempt, tool, schema, inline-size,
artifact-limit, and artifact-ownership checks used by Self::advance
before a reconciliation transaction is attempted.
§Errors
Returns ToolInvocationError unless this revision is unknown and the
result is bound to its exact durable intent and physical attempt.
Sourcepub fn validate_reconciliation_error(
&self,
error: &ToolError,
) -> Result<(), ToolInvocationError>
pub fn validate_reconciliation_error( &self, error: &ToolError, ) -> Result<(), ToolInvocationError>
Validates authoritative failure/effect evidence for an unknown attempt.
The evidence may resolve the invocation to Failed, or deliberately
retain Unknown when the external effect remains uncertain. The same
identity, attempt, risk/effect, and retry-safety checks used by
Self::advance are applied here.
§Errors
Returns ToolInvocationError unless this revision is unknown and the
error is bound to its exact durable intent and physical attempt.
Sourcepub const fn previous(&self) -> Option<&ToolInvocationHead>
pub const fn previous(&self) -> Option<&ToolInvocationHead>
Returns the exact predecessor head, absent only for preparation.
Sourcepub const fn journal_head(&self) -> &JournalHead
pub const fn journal_head(&self) -> &JournalHead
Returns the exact journal prefix anchoring this revision.
Sourcepub const fn transition(&self) -> Option<&ToolInvocationTransition>
pub const fn transition(&self) -> Option<&ToolInvocationTransition>
Returns the explicit transition, absent only for preparation.
Sourcepub const fn transition_digest(&self) -> Option<Digest>
pub const fn transition_digest(&self) -> Option<Digest>
Returns the transition fingerprint, absent only for preparation.
Sourcepub fn head(&self) -> ToolInvocationHead
pub fn head(&self) -> ToolInvocationHead
Returns a compact exact optimistic-comparison token.
Trait Implementations§
Source§impl Clone for ToolInvocation
impl Clone for ToolInvocation
Source§impl Debug for ToolInvocation
impl Debug for ToolInvocation
Source§impl<'de> Deserialize<'de> for ToolInvocation
impl<'de> Deserialize<'de> for ToolInvocation
Source§fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>where
D: Deserializer<'de>,
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>where
D: Deserializer<'de>,
Source§impl JsonSchema for ToolInvocation
impl JsonSchema for ToolInvocation
Source§fn schema_id() -> Cow<'static, str>
fn schema_id() -> Cow<'static, str>
Source§fn json_schema(generator: &mut SchemaGenerator) -> Schema
fn json_schema(generator: &mut SchemaGenerator) -> Schema
Source§fn inline_schema() -> bool
fn inline_schema() -> bool
$ref keyword. Read more