Struct DocumentBlock 

pub struct DocumentBlock {
    pub title: String,
    pub content: Vec<u8>,
    pub format_hint: FormatHint,
}

DOCUMENT block — represents prose or documentation content.

Used for READMEs, design docs, comments, or any non-code textual content that provides context to the LLM. The format_hint tells the renderer how to interpret the body (markdown, plain text, HTML).

Field layout within body:

┌──────────┬───────────┬─────────────┬──────────────────────────┐
│ Field ID │ Wire Type │ Name        │ Description              │
├──────────┼───────────┼─────────────┼──────────────────────────┤
│ 1        │ Bytes     │ title       │ Document title           │
│ 2        │ Bytes     │ content     │ Document body            │
│ 3        │ Varint    │ format_hint │ FormatHint enum byte     │
└──────────┴───────────┴─────────────┴──────────────────────────┘

Fields

title: String

content: Vec<u8>

format_hint: FormatHint

Implementations

impl DocumentBlock

pub fn encode_body(&self) -> Vec<u8>

Serialize this block’s fields into a TLV-encoded body.

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

Deserialize a DOCUMENT block from a TLV-encoded body.

Trait Implementations

impl Clone for DocumentBlock

fn clone(&self) -> DocumentBlock

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocumentBlock

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

Formats the value using the given formatter.

impl PartialEq for DocumentBlock

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

impl StructuralPartialEq for DocumentBlock