Struct DocEntry 

pub struct DocEntry(/* private fields */);

A flexible document entry that serializes as a flat JSON object.

Each entry has a "phase": "runtime" field set automatically.

Implementations

impl DocEntry

pub fn note(text: &str) -> Self

A simple text note.

pub fn tag(names: &[&str]) -> Self

Tag annotation with one or more tag names.

pub fn kv(label: &str, value: Value) -> Self

A key-value pair.

pub fn code(label: &str, content: &str, lang: Option<&str>) -> Self

A code block with optional language.

pub fn json_doc(label: &str, value: &impl Serialize) -> Self

A JSON document rendered as a code block with lang=json.

pub fn table(label: &str, columns: &[&str], rows: &[&[&str]]) -> Self

A table with columns and rows.

pub fn link(label: &str, url: &str) -> Self

A hyperlink.

pub fn section(title: &str, markdown: &str) -> Self

A markdown section.

pub fn mermaid(code: &str, title: Option<&str>) -> Self

A mermaid diagram.

pub fn screenshot(path: &str, alt: Option<&str>) -> Self

A screenshot reference.

pub fn custom(type_name: &str, data: Value) -> Self

A custom doc entry with arbitrary type and data.

pub fn with_children(self, children: Vec<DocEntry>) -> Self

Add children to this doc entry.

Trait Implementations

impl Clone for DocEntry

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Serialize for DocEntry

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.