Enum ToolChunk 

pub enum ToolChunk {
    Progress {
        percent: f32,
        message: String,
    },
    Partial {
        data: Value,
        index: usize,
    },
    Complete {
        result: ToolResult,
    },
    Error {
        tool: String,
        message: String,
        retryable: bool,
    },
}

A chunk of streaming output from a tool.

Security

• Progress updates are rate-limited by design (max 1/100ms recommended)
• Partial data is NOT hashed until Complete (prevents hash oracle attacks)
• Errors stop the stream immediately

Variants

Progress

Progress update (percentage and message)

Fields

percent: f32

Progress percentage (0.0 to 100.0)

message: String

Human-readable status message

Partial

Partial data chunk (intermediate result)

Fields

data: Value

Partial data (NOT hashed for security)

index: usize

Chunk index (0-based)

Complete

Final complete result with cryptographic hash

Fields

result: ToolResult

Final result with Merkle-compatible hash

Error

Error during streaming (terminates stream) Note: Uses String to allow Clone/Serialize without ToolError constraints

Fields

tool: String

Tool name that failed

message: String

Error message (sanitized)

retryable: bool

Whether the error is retryable

Implementations

impl ToolChunk

pub fn progress(percent: f32, message: impl Into<String>) -> Self

Create a progress chunk

pub fn partial(data: Value, index: usize) -> Self

Create a partial data chunk

pub fn complete(result: ToolResult) -> Self

Create a complete chunk from a tool result

pub fn from_error(error: &ToolError) -> Self

Create an error chunk from a ToolError

pub fn error(tool: impl Into<String>, message: impl Into<String>) -> Self

Create a simple error chunk

pub fn is_terminal(&self) -> bool

Check if this chunk terminates the stream

Trait Implementations

impl Clone for ToolChunk

fn clone(&self) -> ToolChunk

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolChunk

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ToolChunk

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ToolChunk

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

where __S: Serializer,

Serialize this value into the given Serde serializer.