Enum ToolResultBlock 

#[non_exhaustive]
pub enum ToolResultBlock {
    Text {
        text: String,
    },
    Image {
        source: Source,
    },
}

One block inside a ToolResultContent::blocks list.

Several blocks can be interleaved inside a single tool reply (e.g. text + a rendered chart), so a tool that generates an image alongside an explanation does not have to choose. Error semantics live on the parent ToolResultContent::is_error, not per-block, so a failed reply can still carry images.

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

Plain text segment of the tool reply.

Fields

text: String

Text content.

Image

Image segment of the tool reply. Adapters that cannot represent images inside tool results surface a typed error.

Fields

source: Source

Image source.

Implementations

impl ToolResultBlock

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

Build a ToolResultBlock::Text.

pub fn image(source: Source) -> Self

Build a ToolResultBlock::Image from the given source.

Trait Implementations

impl Clone for ToolResultBlock

fn clone(&self) -> ToolResultBlock

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolResultBlock

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ToolResultBlock

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ToolResultBlock

fn eq(&self, other: &ToolResultBlock) -> 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 ToolResultBlock

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 ToolResultBlock