Skip to main content

StreamChunk

Enum StreamChunk 

Source
pub enum StreamChunk {
    Text(String),
    ToolUse {
        id: String,
        name: String,
    },
    ToolInputDelta {
        id: String,
        partial_json: String,
    },
    ToolCall {
        call_id: String,
        response_id: String,
        chat_id: Option<String>,
        tool_name: String,
        server: String,
        parameters: Value,
    },
    Usage(Usage),
    Done,
}
Expand description

Streaming chunk from a chat completion

Variants§

§

Text(String)

Text delta

§

ToolUse

Tool use started.

Fields

§id: String

Unique tool use identifier.

§name: String

Name of the tool being invoked.

§

ToolInputDelta

Tool input delta (partial JSON streaming).

Fields

§id: String

Tool use identifier this delta belongs to.

§partial_json: String

Partial JSON fragment.

§

ToolCall

Tool call request from backend (for client-side execution).

Fields

§call_id: String

Unique call identifier.

§response_id: String

Response identifier for correlating results.

§chat_id: Option<String>

Chat session identifier, if any.

§tool_name: String

Name of the tool to execute.

§server: String

MCP server name hosting the tool.

§parameters: Value

Parameters for the tool call.

§

Usage(Usage)

Usage statistics (usually sent at the end)

§

Done

Stream completed

Trait Implementations§

Source§

impl Clone for StreamChunk

Source§

fn clone(&self) -> StreamChunk

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for StreamChunk

Source§

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

Formats the value using the given formatter. 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> 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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.