Enum ContentBlock 

pub enum ContentBlock {
    Text {
        text: String,
    },
    Thinking {
        text: String,
    },
    Image {
        mime_type: String,
        source: ImageSource,
    },
    ToolCall {
        tool_call_id: ToolCallId,
        provider_call_id: Option<String>,
        tool_name: String,
        arguments: Value,
    },
    HostedTool {
        activity: HostedToolActivity,
    },
    Citation {
        citation: SourceCitation,
    },
}

A provider-neutral message content block.

Variants

Text

Visible text content.

Fields

text: String

UTF-8 text.

Thinking

Model reasoning content that products may choose to hide.

Fields

text: String

UTF-8 reasoning text.

Image

Image content with a MIME type and source.

Fields

mime_type: String

Image MIME type.

source: ImageSource

Inline or referenced image source.

ToolCall

A request to invoke a named tool.

Fields

tool_call_id: ToolCallId

Canonical tool-call identifier.

provider_call_id: Option<String>

Opaque provider identifier used to continue the model conversation.

tool_name: String

Registered tool name.

arguments: Value

Provider-neutral JSON arguments.

HostedTool

One complete provider-hosted activity, including normalized sources.

Fields

activity: HostedToolActivity

Validated activity and opaque same-provider continuation state.

Citation

A normalized citation associated with assistant text.

Fields

citation: SourceCitation

Validated cited source and optional provider continuation state.

Implementations

impl ContentBlock

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

Creates a validated visible text block.

Errors

Returns ContentValidationError::InvalidText when the text is empty, contains a null character, or exceeds MAX_TEXT_BLOCK_BYTES.

pub fn thinking(text: impl Into<String>) -> Result<Self, ContentValidationError>

Creates a validated thinking block.

Errors

Returns ContentValidationError::InvalidText when the text is empty, contains a null character, or exceeds MAX_TEXT_BLOCK_BYTES.

pub fn inline_image( mime_type: impl Into<String>, data: impl Into<String>, ) -> Result<Self, ContentValidationError>

Creates a validated inline Base64 image block.

Errors

Returns an error when the MIME type is invalid or the data is empty, oversized, or not valid standard Base64.

pub fn image_reference( mime_type: impl Into<String>, reference: impl Into<String>, ) -> Result<Self, ContentValidationError>

Creates a validated referenced image block.

Errors

Returns an error when the MIME type or bounded reference is invalid.

pub fn tool_call( tool_call_id: ToolCallId, tool_name: impl Into<String>, arguments: Value, ) -> Result<Self, ContentValidationError>

Creates a validated tool-call block.

Errors

Returns an error when the tool name is invalid, arguments are not an object, or arguments exceed the byte or nesting limits.

pub fn tool_call_with_provider_id( tool_call_id: ToolCallId, provider_call_id: impl Into<String>, tool_name: impl Into<String>, arguments: Value, ) -> Result<Self, ContentValidationError>

Creates a validated tool-call block that retains its provider identifier.

Errors

Returns an error when the provider identifier, tool name, or arguments violate their protocol bounds.

pub fn hosted_tool(activity: HostedToolActivity) -> Self

Wraps one validated provider-hosted tool activity.

pub fn citation(citation: SourceCitation) -> Self

Wraps one validated external source citation.

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

Returns the opaque provider identifier for a tool-call 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: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ContentBlock

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ContentBlock

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 ContentBlock