Enum ContentBlock 

pub enum ContentBlock {
    Known(KnownBlock),
    Other(Value),
}

One block of content within a message.

Forward-compatible: unknown type tags deserialize into ContentBlock::Other with the raw JSON preserved.

Variants

Known(KnownBlock)

A block whose type is recognized by this SDK version.

Other(Value)

A block whose type is not recognized; the raw JSON is preserved.

Implementations

impl ContentBlock

pub fn known(&self) -> Option<&KnownBlock>

If this is a known block, return the inner KnownBlock.

pub fn other(&self) -> Option<&Value>

If this is an unknown block, return the raw JSON.

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

Returns the wire-level type tag for this block, regardless of variant.

For known blocks this returns the snake_case discriminant; for unknown blocks it returns whatever string the server sent in the type field (or None if the field was missing or non-string).

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

Convenience constructor for a plain text block.

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

Convenience constructor for a URL-sourced image block.

use claude_api::messages::ContentBlock;
let block = ContentBlock::image_url("https://example.com/cat.png");
assert_eq!(block.type_tag(), Some("image"));

pub fn image_base64( media_type: impl Into<String>, data: impl Into<String>, ) -> Self

Convenience constructor for a base64-encoded image block. media_type is the IANA MIME type (e.g. "image/png"); data is base64.

pub fn document_text(data: impl Into<String>, title: Option<&str>) -> Self

Convenience constructor for an inline-text document block. Cites the document by title if provided.

use claude_api::messages::ContentBlock;
let block = ContentBlock::document_text("Page contents.", Some("Spec"));
assert_eq!(block.type_tag(), Some("document"));

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

Convenience constructor for a URL-sourced document block.

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

Convenience constructor: a text block with an ephemeral cache breakpoint at the default (5-minute) TTL. Use this on the last block of a long-lived prefix you expect to reuse across requests.

use claude_api::messages::ContentBlock;
let block = ContentBlock::text_cached("Be concise.");
assert_eq!(block.type_tag(), Some("text"));

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>>(d: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl From<ContentBlock> for MessageContent

fn from(b: ContentBlock) -> Self

Converts to this type from the input type.

impl From<KnownBlock> for ContentBlock

fn from(k: KnownBlock) -> Self

Converts to this type from the input type.

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, s: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ContentBlock