Struct ResponseMetadata 

pub struct ResponseMetadata {
    pub truncated: Option<bool>,
    pub original_size: Option<usize>,
    pub final_size: Option<usize>,
    pub item_count: Option<usize>,
    pub total_items: Option<usize>,
    pub compressed: Option<bool>,
    pub retrieval_ref: Option<String>,
}

Metadata about a tool response

This provides additional context about the response, such as whether the output was truncated or the original size of the data.

Fields

truncated: Option<bool>

Whether the output was truncated to fit size limits

original_size: Option<usize>

Original size of the data before truncation (in bytes or count)

final_size: Option<usize>

Final size after truncation

item_count: Option<usize>

Number of items (for lists/arrays)

total_items: Option<usize>

Total items before truncation

compressed: Option<bool>

Whether data was compressed/stored for retrieval

retrieval_ref: Option<String>

Reference ID for retrieving full data

Implementations

impl ResponseMetadata

pub fn truncated(original_size: usize, final_size: usize) -> Self

Create metadata for truncated output

pub fn for_list(item_count: usize, total_items: usize) -> Self

Create metadata for a list with item counts

pub fn compressed(retrieval_ref: String, original_size: usize) -> Self

Create metadata for compressed output with retrieval reference

pub fn is_modified(&self) -> bool

Check if this metadata indicates any modification (truncation/compression)

Trait Implementations

impl Clone for ResponseMetadata

fn clone(&self) -> ResponseMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ResponseMetadata

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

Formats the value using the given formatter.

impl Default for ResponseMetadata

fn default() -> ResponseMetadata

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ResponseMetadata

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ResponseMetadata

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

where __S: Serializer,

Serialize this value into the given Serde serializer.