Documentation
¶
Overview ¶
Package describe provides the shared rendering primitives used by the Describe / DescribeList / DescribeWithCallback trio implemented on every winacl structure.
Each structure exposes its output as a flat list of lines at indentation depth 0 via DescribeList(). Rendering (adding indentation and choosing where the text goes) is layered on top:
DescribeList() -> []string, the lines at indent 0
DescribeWithCallback(indent, -> prepends indent levels and routes each bare
printf) line (no terminator) to a fmt.Printf-like callback
Describe(indent) -> DescribeWithCallback(indent, describe.Printfln)
A parent structure composes its own list from its children's by nesting each child's DescribeList() one level deeper with Nest.
Index ¶
Constants ¶
const Unit = " │ "
Unit is one level of indentation in the Describe tree output.
Variables ¶
This section is empty.
Functions ¶
func Nest ¶
Nest prefixes each of the given lines with one indentation Unit. It is used to compose a parent's DescribeList from its children's DescribeList output.
func Printfln ¶
Printfln is the default Describe sink: a Printf-compatible callback that writes to stdout and appends a trailing newline. WithCallback emits bare lines (no terminator), so the sink decides how each line is terminated; Printfln is what Describe uses to reproduce the one-line-per-entry output.
func WithCallback ¶
WithCallback renders lines at the given indentation depth: it prepends indent copies of Unit to each line and routes the result to printf. Lines are emitted bare, without a trailing newline; the callback decides how (and whether) each line is terminated. Describe passes Printfln to add the newline for stdout.
Source Files