Enum ToolProgress 

#[non_exhaustive]
pub enum ToolProgress {
    Text {
        text: String,
    },
    Partial {
        delta: String,
        total_bytes: u64,
        truncated: bool,
        gap: u64,
    },
    Custom {
        subkind: String,
        payload: Value,
    },
}

Progress payload shapes.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Text

Free-form text chunk.

Fields

text: String

Chunk body.

Partial

Incremental partial output (W3.3).

Fields

delta: String

UTF-8-safe delta slice.

total_bytes: u64

Total bytes emitted so far (including this delta).

truncated: bool

Whether this delta was truncated to the frame cap.

gap: u64

Byte gap skipped since last partial (e.g. after truncation).

Custom

Tool-defined progress.

Fields

subkind: String

Stable producer discriminator.

payload: Value

Arbitrary payload.

Implementations

impl ToolProgress

pub fn text(text: impl Into<String>) -> Self

Text progress helper.

pub fn partial( delta: impl Into<String>, total_bytes: u64, truncated: bool, gap: u64, ) -> Self

Partial progress helper.

Trait Implementations

impl Clone for ToolProgress

fn clone(&self) -> ToolProgress

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolProgress

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ToolProgress

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ToolProgress

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ToolProgress

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ToolProgress