Struct ContentChunk 

#[non_exhaustive]
pub struct ContentChunk {
    pub content: ContentBlock,
    pub message_id: MessageId,
    pub meta: Option<Map<String, Value>>,
}

Available on crate feature unstable_protocol_v2 only.

A streamed item of content

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

content: ContentBlock

A single item of content

message_id: MessageId

A unique identifier for the message this chunk belongs to.

All chunks belonging to the same message share the same messageId. A change in messageId indicates a new message has started.

meta: Option<Map<String, Value>>

The _meta property is reserved by ACP to allow clients and agents to attach additional metadata to their interactions. Implementations MUST NOT make assumptions about values at these keys.

See protocol docs: Extensibility

Implementations

impl ContentChunk

pub fn new( content: ContentBlock, message_id: impl Into<MessageId>, ) -> ContentChunk

pub fn message_id(self, message_id: impl Into<MessageId>) -> ContentChunk

A unique identifier for the message this chunk belongs to.

All chunks belonging to the same message share the same messageId. A change in messageId indicates a new message has started.

pub fn meta(self, meta: impl IntoOption<Map<String, Value>>) -> ContentChunk

The _meta property is reserved by ACP to allow clients and agents to attach additional metadata to their interactions. Implementations MUST NOT make assumptions about values at these keys.

See protocol docs: Extensibility

Trait Implementations

impl Clone for ContentChunk

fn clone(&self) -> ContentChunk

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ContentChunk

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ContentChunk

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl IntoV1 for ContentChunk

type Output = ContentChunk

The corresponding v1 type.

fn into_v1( self, ) -> Result<<ContentChunk as IntoV1>::Output, ProtocolConversionError>

Converts this value into the corresponding v1 type.

impl JsonSchema for ContentChunk

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for ContentChunk

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

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 ContentChunk