Struct TextBlock 

pub struct TextBlock {
    pub citations: Option<Vec<TextCitation>>,
    pub text: String,
    pub cache_control: Option<CacheControlEphemeral>,
}

Available on crate feature anthropic-client only.

A block of text content in a message.

TextBlocks contain plain text content and optional citations.

Fields

citations: Option<Vec<TextCitation>>

Optional citations supporting the text block.

The type of citation returned will depend on the type of document being cited. Citing a PDF results in page_location, plain text results in char_location, and content document results in content_block_location.

text: String

The text content.

cache_control: Option<CacheControlEphemeral>

Create a cache control breakpoint at this content block.

Implementations

impl TextBlock

pub fn new<S>(text: S) -> TextBlock

where S: Into<String>,

Creates a new TextBlock with the specified text.

pub fn with_citations<S>(text: S, citations: Vec<TextCitation>) -> TextBlock

where S: Into<String>,

Creates a new TextBlock with the specified text and citations.

pub fn with_cache_control( self, cache_control: CacheControlEphemeral, ) -> TextBlock

Add a cache control to this text block.

pub fn with_citation(self, citation: TextCitation) -> TextBlock

Add a single citation to this text block.

pub fn citation_count(&self) -> usize

Returns the number of citations if any, or 0 if there are none.

pub fn has_citations(&self) -> bool

Returns true if this text block has citations.

Trait Implementations

impl Clone for TextBlock

fn clone(&self) -> TextBlock

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TextBlock

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TextBlock

fn deserialize<__D>( __deserializer: __D, ) -> Result<TextBlock, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<TextBlock> for Content

fn from(text_block: TextBlock) -> Content

Converts to this type from the input type.

impl From<TextBlock> for ContentBlock

Helper methods to create ContentBlock variants

fn from(block: TextBlock) -> ContentBlock

Converts to this type from the input type.

impl FromStr for TextBlock

type Err = Infallible

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<TextBlock, <TextBlock as FromStr>::Err>

Parses a string s to return a value of this type.

impl PartialEq for TextBlock

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

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for TextBlock