Enum ContentBlock 

#[non_exhaustive]
pub enum ContentBlock {
    Text {
        text: String,
    },
    Image {
        source: ImageSource,
    },
    ToolCall {
        id: String,
        name: String,
        arguments: String,
    },
    Reasoning {
        text: String,
        signature: Option<String>,
    },
    Other {
        type_name: String,
        data: ExtraMap,
    },
}

A single block of content returned by an LLM provider.

Uses custom serde to produce a flat {"type": "...", ...} JSON shape rather than Rust’s default externally-tagged enum encoding.

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 output block

Fields

text: String

Text emitted by the provider.

Image

Image output block

Fields

source: ImageSource

Image payload returned by the provider.

ToolCall

Tool call block emitted by the model

Fields

id: String

Provider-issued tool call identifier.

name: String

Tool name selected by the model.

arguments: String

Raw JSON string containing the tool-call arguments.

Reasoning

Reasoning block emitted by the model

Fields

text: String

Reasoning text emitted by the provider.

signature: Option<String>

Optional provider-specific signature for the reasoning block.

Other

Catch-all for content blocks the portable enum does not model.

type_name carries the wire-level "type" discriminator and data holds the rest of the block’s fields verbatim. Serialization re-emits the original flat {"type": type_name, ...data} shape, so unknown block kinds round-trip losslessly through ChatResponseRecord.

Provider crates translate unrecognized wire block types into Other rather than dropping them, which preserves provider-specific content for callers that opt into reading it. Application code typically inspects type_name and either handles known provider extensions or treats the block as opaque.

Fields

type_name: String

Wire-level "type" discriminator for this block.

data: ExtraMap

Remaining block fields, preserved verbatim from the wire.

Implementations

impl ContentBlock

pub fn as_text(&self) -> Option<&str>

Borrow the text content for a text block.

pub fn as_image(&self) -> Option<ImageBlockRef<'_>>

Borrow the image content for an image block without cloning it.

pub fn as_tool_call(&self) -> Option<ToolCallRef<'_>>

Borrow the tool call payload for a tool-call block without cloning it.

pub fn as_reasoning(&self) -> Option<&str>

Borrow the reasoning text for a reasoning block.

Trait Implementations

impl Clone for ContentBlock

fn clone(&self) -> ContentBlock

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ContentBlock

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ContentBlock

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for ContentBlock

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

Formats the value using the given formatter.

impl PartialEq for ContentBlock

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

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl Eq for ContentBlock

impl StructuralPartialEq for ContentBlock