Struct CachedResultEnvelope 

pub struct CachedResultEnvelope {
    pub handle: CachedResultHandle,
    pub total_items: usize,
    pub page_size: usize,
    pub first_page: Vec<Value>,
    pub truncated: bool,
    pub omitted_items: usize,
    pub page_token: Option<String>,
}

JSON envelope returned to the model in place of an oversized array.

The model sees first_page directly and can request later pages by calling a host-supplied page tool with handle and an offset. The envelope is deliberately small and self-describing so the model can reason about how much data is hidden behind the handle. The truncation fields mirror rig_compose::ToolResultEnvelope semantics for MCP result caches: the cache does not discard data, but the model-visible page is bounded and carries enough metadata for a follow-up page request.

Fields

handle: CachedResultHandle

Opaque handle for the full cached result.

total_items: usize

Total number of items the cache holds for this handle.

page_size: usize

Page size the cache will use when serving subsequent pages.

first_page: Vec<Value>

First page_size.min(total_items) items, inlined so the model doesn’t always have to do a follow-up call.

truncated: bool

Whether the model-visible page omitted cached items.

omitted_items: usize

Number of cached items omitted from first_page.

page_token: Option<String>

Stable follow-up token for the first omitted page.

Implementations

impl CachedResultEnvelope

pub fn page_token(handle: &CachedResultHandle, offset: usize) -> String

Build the follow-up page token for handle and the next offset.

Trait Implementations

impl Clone for CachedResultEnvelope

fn clone(&self) -> CachedResultEnvelope

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CachedResultEnvelope

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CachedResultEnvelope

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for CachedResultEnvelope

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CachedResultEnvelope