Enum Delta 

pub enum Delta {
    BeginPart {
        part_id: PartId,
        kind: PartKind,
    },
    AppendText {
        part_id: PartId,
        chunk: String,
    },
    AppendBytes {
        part_id: PartId,
        chunk: Vec<u8>,
    },
    ReplaceStructured {
        part_id: PartId,
        value: Value,
    },
    SetMetadata {
        part_id: PartId,
        metadata: MetadataMap,
    },
    CommitPart {
        part: Part,
    },
}

An incremental update emitted while a model turn is streaming.

The provider adapter emits a sequence of Delta values that the loop and reporters consume to reconstruct the full Item progressively. A typical sequence looks like:

1. BeginPart – allocates a new part buffer.
2. One or more AppendText / AppendBytes – fills the buffer.
3. CommitPart – finalises the part.

Example

use agentkit_core::{Delta, PartId, PartKind};

let deltas = vec![
    Delta::BeginPart { part_id: PartId::new("p1"), kind: PartKind::Text },
    Delta::AppendText { part_id: PartId::new("p1"), chunk: "Hello".into() },
    Delta::AppendText { part_id: PartId::new("p1"), chunk: ", world!".into() },
];

assert_eq!(deltas.len(), 3);

Variants

BeginPart

Signals the start of a new part with the given kind.

Fields

part_id: PartId

Identifier for the part being constructed.

kind: PartKind

The kind of part being started.

AppendText

Appends a text chunk to an in-progress part.

Fields

part_id: PartId

Identifier of the target part.

chunk: String

The text chunk to append.

AppendBytes

Appends raw bytes to an in-progress part.

Fields

part_id: PartId

Identifier of the target part.

chunk: Vec<u8>

The byte chunk to append.

ReplaceStructured

Replaces the structured value of an in-progress part wholesale.

Fields

part_id: PartId

Identifier of the target part.

value: Value

The new structured value.

SetMetadata

Sets or replaces the metadata on an in-progress part.

Fields

part_id: PartId

Identifier of the target part.

metadata: MetadataMap

The new metadata map.

CommitPart

Finalises a part, providing the fully assembled Part.

Fields

part: Part

The completed part.

Trait Implementations

impl Clone for Delta

fn clone(&self) -> Delta

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Delta

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Delta

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Delta

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Delta

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 Delta