Skip to main content

ContentBlock

Enum ContentBlock 

Source
#[non_exhaustive]
pub enum ContentBlock { Text { text: String, }, ToolUse { id: String, name: String, input: Value, }, ToolResult { tool_use_id: String, content: String, is_error: bool, }, }
Expand description

One piece of a message’s content.

A message is a list of blocks rather than a string because a single assistant turn routinely mixes prose with tool calls, and a user turn mixes prose with tool results. Flattening that to text loses the pairing between a call and its result — which is one of the concrete ways a handoff drops context.

Variants (Non-exhaustive)§

This enum is marked as 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 prose.

Fields

§text: String

The prose itself.

§

ToolUse

The model asking for a tool to be run.

Fields

§id: String

Correlates with the matching ContentBlock::ToolResult.

§name: String

Which tool — a crate::tool::ToolSpec::name.

§input: Value

Arguments, shaped by the tool’s declared schema.

§

ToolResult

The answer to a ContentBlock::ToolUse.

Fields

§tool_use_id: String

The id of the ContentBlock::ToolUse this answers.

§content: String

The tool’s output — or its error text — as the model will read it.

§is_error: bool

The tool failed and content is its error text.

Implementations§

Source§

impl ContentBlock

Source

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

A prose block.

Source

pub fn tool_use( id: impl Into<String>, name: impl Into<String>, input: Value, ) -> Self

A tool call: run name with input; id pairs it with its result.

Source

pub fn tool_result( tool_use_id: impl Into<String>, content: impl Into<String>, ) -> Self

A successful tool result, answering the call identified by tool_use_id.

Source

pub fn tool_error( tool_use_id: impl Into<String>, content: impl Into<String>, ) -> Self

A failed tool call. Reported to the model rather than raised, so it can adapt — a tool that errors is information, not the end of the turn.

Source

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

The prose in this block, if it is prose.

Trait Implementations§

Source§

impl Clone for ContentBlock

Source§

fn clone(&self) -> ContentBlock

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ContentBlock

Source§

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

Formats the value using the given formatter. Read more
Source§

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

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for ContentBlock

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for ContentBlock

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for ContentBlock

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> AsAny for T
where T: Any,

Source§

fn as_any(&self) -> &(dyn Any + 'static)

The receiver as &dyn Any, ready for downcast_ref.
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,