Skip to main content

ToolInvocation

Struct ToolInvocation 

Source
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

Source

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.

Source

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.

Source

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.

Source

pub const fn intent(&self) -> &ToolInvocationIntent

Returns the immutable preparation intent.

Source

pub const fn revision(&self) -> ToolInvocationRevision

Returns this record’s monotonic revision.

Source

pub const fn state(&self) -> &ToolInvocationState

Returns the integrity-bound lifecycle state.

Source

pub const fn status(&self) -> ToolInvocationStatus

Returns the lifecycle discriminator.

Source

pub const fn attempt_id(&self) -> Option<AttemptId>

Returns the physical attempt represented by this revision, if any.

Source

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.

Source

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.

Source

pub const fn previous(&self) -> Option<&ToolInvocationHead>

Returns the exact predecessor head, absent only for preparation.

Source

pub const fn journal_head(&self) -> &JournalHead

Returns the exact journal prefix anchoring this revision.

Source

pub const fn transition(&self) -> Option<&ToolInvocationTransition>

Returns the explicit transition, absent only for preparation.

Source

pub const fn transition_digest(&self) -> Option<Digest>

Returns the transition fingerprint, absent only for preparation.

Source

pub const fn digest(&self) -> Digest

Returns the complete domain-separated record checksum.

Source

pub fn head(&self) -> ToolInvocationHead

Returns a compact exact optimistic-comparison token.

Trait Implementations§

Source§

impl Clone for ToolInvocation

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ToolInvocation

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for ToolInvocation

Source§

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl JsonSchema for ToolInvocation

Source§

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema. Read more
Source§

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type. Read more
Source§

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type. Read more
Source§

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword. Read more
Source§

impl Serialize for ToolInvocation

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.