Struct Summary 

pub struct Summary {
    pub text: String,
}

Summary sub-block — a compact UTF-8 description prefixed to the body when the block’s HAS_SUMMARY flag is set.

The summary is designed for token-budget-aware rendering: when a block is too large to include in full, the renderer can substitute the summary to preserve context without blowing the token budget.

Wire layout (within the block body, before any TLV fields):

┌─────────────────────────────────────────────────────┐
│ summary_len  (varint)         — byte length of text │
│ summary_text [summary_len]    — UTF-8 bytes         │
│ ... remaining TLV fields ...                        │
└─────────────────────────────────────────────────────┘

The summary is always the first thing in the body when present. The decoder checks BlockFlags::has_summary() before attempting to read it.

Fields

text: String

Implementations

impl Summary

pub fn encode(&self, buf: &mut Vec<u8>)

Encode this summary into the front of a body buffer.

Writes text.len() as a varint followed by the raw UTF-8 bytes. Call this before appending the block’s TLV fields.

pub fn decode(buf: &[u8]) -> Result<(Self, usize), TypeError>

Decode a summary from the front of a body buffer.

Returns (summary, bytes_consumed). The caller should slice the body past bytes_consumed before decoding TLV fields.

Trait Implementations

impl Clone for Summary

fn clone(&self) -> Summary

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Summary

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

Formats the value using the given formatter.

impl PartialEq for Summary

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

impl StructuralPartialEq for Summary