Skip to main content

ToolCallMembers

Struct ToolCallMembers 

Source
#[non_exhaustive]
pub struct ToolCallMembers {
Show 23 fields pub tool: Option<String>, pub call_id: Option<String>, pub args: Option<String>, pub failure_reason: Option<String>, pub failure_kind: Option<String>, pub visible_output: Option<String>, pub output_ref: Option<OutputRef>, pub tool_receipt: Option<Box<ToolReceipt>>, pub patch_summary: Option<PatchSummary>, pub patch_ref: Option<OutputRef>, pub model_visible_content: Option<Vec<ModelVisibleContent>>, pub approval_id: Option<String>, pub background: Option<bool>, pub background_initiator: Option<BackgroundInitiator>, pub background_status: Option<BackgroundStatus>, pub status_line: Option<String>, pub status_phase: Option<String>, pub status_progress: Option<StatusProgress>, pub status_step: Option<StatusStep>, pub status_attempt: Option<StatusAttempt>, pub status_health: Option<StatusHealth>, pub status_children: Option<StatusChildren>, pub display_label: Option<Box<ToolDisplayLabel>>,
}
Expand description

toolCall members, flattened into the item row.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§tool: Option<String>

toolCall: tool name.

§call_id: Option<String>

toolCall: the provider call id (call_...), opaque.

§args: Option<String>

toolCall: the model-authored argument JSON, verbatim; clients parse. Verbatim keeps the fold byte-deterministic and survives model-emitted almost-JSON.

§failure_reason: Option<String>

toolCall/subagent: Failed/Rejected/Cancelled reason text, verbatim.

§failure_kind: Option<String>

toolCall: machine-readable failure class.

§visible_output: Option<String>

toolCall/userShell: bounded transcript-visible result text; streams via item/delta field "output".

§output_ref: Option<OutputRef>

toolCall/userShell: stored-output reference; fetch the full bytes via item/readOutput.

§tool_receipt: Option<Box<ToolReceipt>>

toolCall: the shared semantic receipt — what the operation did, as machine-readable fact. Optional and additive: absence is always valid and is never an error. When present, a server serves the same receipt on every item path — item/completed, view/page, seeded snapshots and resume. Observation only; carries no control authority, and no field in it enters model-visible content.

§patch_summary: Option<PatchSummary>

toolCall: server-authored edit-family diff summary — always beside patchRef; absent = no diff available.

§patch_ref: Option<OutputRef>

toolCall: stored structured-patch reference (kind: "tool_patch", mediaType: "application/json"); the body is fetched via item/readOutput with patchRef.id, and the ref survives the elided-snapshot rung exactly like outputRef without ever being an elision trigger.

§model_visible_content: Option<Vec<ModelVisibleContent>>

toolCall: rich content the model saw beyond text; base64 is not inlined on the view.

§approval_id: Option<String>

toolCall: the approval that gated this call; join key for the approval view events.

§background: Option<bool>

toolCall: true once the task was durably backgrounded; delivered via item/updated.

§background_initiator: Option<BackgroundInitiator>

toolCall: who backgrounded the task; absent on pre-split records — never inferred.

§background_status: Option<BackgroundStatus>

toolCall: the backgrounded-row payload for a running backgrounded item — auto-yield or an explicit user/timeout background; may appear with or without background/backgroundInitiator. Experimental, delivered via item/updated. Presentation only — never a durability claim.

§status_line: Option<String>

toolCall: the task’s visible latest-status line — the latest Status message through the shared detail normalization; absent when no status folded or nothing displayable remains.

§status_phase: Option<String>

toolCall: the latest detail’s phase row, verbatim; absent when the latest detail carries none.

§status_progress: Option<StatusProgress>

toolCall: the latest progress facet, field-for-field; absent when the latest detail carries none.

§status_step: Option<StatusStep>

toolCall: the latest active-step facet, field-for-field; absent when the latest detail carries none.

§status_attempt: Option<StatusAttempt>

toolCall: the latest external-attempt facet, field-for-field — countdown inputs the client renders the tick from; absent when the latest detail carries none.

§status_health: Option<StatusHealth>

toolCall: the latest health facet, field-for-field; absent when the latest detail carries none.

§status_children: Option<StatusChildren>

toolCall: the latest child-summary facet, field-for-field; absent when the latest detail carries none.

§display_label: Option<Box<ToolDisplayLabel>>

toolCall: the tool’s own words for this call; absent = none.

Trait Implementations§

Source§

impl Clone for ToolCallMembers

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 ToolCallMembers

Source§

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

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

impl Default for ToolCallMembers

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for ToolCallMembers

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 PartialEq for ToolCallMembers

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl Serialize for ToolCallMembers

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
Source§

impl StructuralPartialEq for ToolCallMembers

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> 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> 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.