Enum ContentBlock 

#[non_exhaustive]
pub enum ContentBlock {
    Text(Text),
    Image(Image),
    ToolCall(ToolCall),
    Reasoning(Reasoning),
    Refusal(Refusal),
    ProviderToolCall(ProviderToolCall),
    ProviderToolResult(ProviderToolResult),
    Other(OtherContent),
}

A block of model output.

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(Text)

Text output.

Image(Image)

Image output.

ToolCall(ToolCall)

A tool call.

Reasoning(Reasoning)

Reasoning output.

Refusal(Refusal)

Text in which the model declines to answer; not answer text.

ProviderToolCall(ProviderToolCall)

A tool call the provider executed itself.

ProviderToolResult(ProviderToolResult)

The outcome of a provider-executed tool call.

Other(OtherContent)

Content the portable model does not represent.

Implementations

impl ContentBlock

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

A text block.

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

A reasoning block.

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

A refusal block: text in which the model declined to answer.

pub fn tool_call( id: impl Into<String>, name: impl Into<String>, arguments: impl Into<String>, ) -> Self

A tool-call block.

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

Borrow the text of a text block.

pub fn as_image(&self) -> Option<&Image>

Borrow an image block.

pub fn as_tool_call(&self) -> Option<&ToolCall>

Borrow a tool-call block.

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

Borrow a reasoning block.

pub fn as_refusal(&self) -> Option<&Refusal>

Borrow a refusal block.

pub fn as_provider_tool_call(&self) -> Option<&ProviderToolCall>

Borrow a provider tool call block.

pub fn as_provider_tool_result(&self) -> Option<&ProviderToolResult>

Borrow a provider tool result block.

pub fn provider_data(&self) -> &ProviderData

Borrow the block’s provider data.

pub fn provider_data_mut(&mut self) -> &mut ProviderData

Mutably borrow the block’s provider data.

pub fn type_name(&self) -> &str

Wire-level type name of the block.

pub fn block_type(&self) -> StreamBlockType

The portable type of the block, as a stream announces it in its BlockStart (StreamBlockType). Every kind of block has one, so StreamBlockType::ALL lists every kind of block.

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

The namespace of the provider that produced the block, for blocks without portable meaning (provider tool blocks, Other).

Trait Implementations

impl Clone for ContentBlock

fn clone(&self) -> Self

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 Eq for ContentBlock

impl From<Image> for ContentBlock

fn from(value: Image) -> Self

Converts to this type from the input type.

impl From<OtherContent> for ContentBlock

fn from(value: OtherContent) -> Self

Converts to this type from the input type.

impl From<ProviderToolCall> for ContentBlock

fn from(value: ProviderToolCall) -> Self

Converts to this type from the input type.

impl From<ProviderToolResult> for ContentBlock

fn from(value: ProviderToolResult) -> Self

Converts to this type from the input type.

impl From<Reasoning> for ContentBlock

fn from(value: Reasoning) -> Self

Converts to this type from the input type.

impl From<Refusal> for ContentBlock

fn from(value: Refusal) -> Self

Converts to this type from the input type.

impl From<Text> for ContentBlock

fn from(value: Text) -> Self

Converts to this type from the input type.

impl From<ToolCall> for ContentBlock

fn from(value: ToolCall) -> Self

Converts to this type from the input type.

impl PartialEq for ContentBlock

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

Equality operator ==.

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

Inequality operator !=.

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 StructuralPartialEq for ContentBlock