https://adz.github.io/FsFlow/reference/diagnostics/ Recent content in Diagnostics on FsFlow Hugo en-us https://adz.github.io/FsFlow/reference/diagnostics/t-diagnostic/ Mon, 01 Jan 0001 00:00:00 +0000 https://adz.github.io/FsFlow/reference/diagnostics/t-diagnostic/ <p>A single failure item attached to a path in a validation graph.</p> https://adz.github.io/FsFlow/reference/diagnostics/t-diagnostics/ Mon, 01 Jan 0001 00:00:00 +0000 https://adz.github.io/FsFlow/reference/diagnostics/t-diagnostics/ <p>A mergeable validation graph that carries local errors and nested child branches.</p> <h2 id="remarks">Remarks</h2> <para> `Errors` holds the application errors attached exactly to the current node, while `Children` holds nested branches keyed by `PathSegment`. </para> <para> This structure allows hierarchical validation to stay navigable before flattening. Use `flatten` to convert it into a linear list. </para> https://adz.github.io/FsFlow/reference/diagnostics/m-diagnosticsmodule-empty/ Mon, 01 Jan 0001 00:00:00 +0000 https://adz.github.io/FsFlow/reference/diagnostics/m-diagnosticsmodule-empty/ <p>Creates an empty diagnostics graph with no errors.</p> <h2 id="returns">Returns</h2> <p>An empty <code>Diagnostics</code>.</p> https://adz.github.io/FsFlow/reference/diagnostics/m-diagnosticsmodule-flatten/ Mon, 01 Jan 0001 00:00:00 +0000 https://adz.github.io/FsFlow/reference/diagnostics/m-diagnosticsmodule-flatten/ <p>Flattens the structured diagnostics graph into a linear list of diagnostics.</p> <h2 id="remarks">Remarks</h2> <p>During flattening, child paths are accumulated from the root down into each emitted diagnostic. The tree itself stores only local errors and child branches, while <code>Diagnostic</code> is reserved for reporting output.</p> <h2 id="parameters">Parameters</h2> <ul> <li><code>graph</code>: The <code>Diagnostics</code> to flatten.</li> </ul> <h2 id="returns">Returns</h2> <p>A list of type <code>Diagnostic</code> list.</p> https://adz.github.io/FsFlow/reference/diagnostics/m-diagnosticsmodule-merge/ Mon, 01 Jan 0001 00:00:00 +0000 https://adz.github.io/FsFlow/reference/diagnostics/m-diagnosticsmodule-merge/ <p>Recursively merges two diagnostics graphs, combining shared branches and local errors.</p> <h2 id="remarks">Remarks</h2> <p>This is the core operation for applicative validation. It ensures that errors from sibling fields are collected together into a single structured graph.</p> <h2 id="parameters">Parameters</h2> <ul> <li><code>left</code>: The first graph of type <code>Diagnostics</code>.</li> <li><code>right</code>: The second graph of type <code>Diagnostics</code>.</li> </ul> <h2 id="returns">Returns</h2> <p>A new <code>Diagnostics</code> containing the union of both inputs.</p> https://adz.github.io/FsFlow/reference/diagnostics/t-path/ Mon, 01 Jan 0001 00:00:00 +0000 https://adz.github.io/FsFlow/reference/diagnostics/t-path/ <p>A path through a validation graph, represented as a list of <code>PathSegment</code>.</p> https://adz.github.io/FsFlow/reference/diagnostics/t-pathsegment/ Mon, 01 Jan 0001 00:00:00 +0000 https://adz.github.io/FsFlow/reference/diagnostics/t-pathsegment/ <p>Location markers used to describe where a diagnostic belongs in a validation graph.</p> https://adz.github.io/FsFlow/reference/diagnostics/m-diagnosticsmodule-singleton/ Mon, 01 Jan 0001 00:00:00 +0000 https://adz.github.io/FsFlow/reference/diagnostics/m-diagnosticsmodule-singleton/ <p>Creates a diagnostics graph containing exactly one error at the root.</p> <h2 id="parameters">Parameters</h2> <ul> <li><code>error</code>: The application error to store at the root.</li> </ul> <h2 id="returns">Returns</h2> <p>A <code>Diagnostics</code> with a single error.</p> https://adz.github.io/FsFlow/reference/diagnostics/m-diagnosticsmodule-tostring/ Mon, 01 Jan 0001 00:00:00 +0000 https://adz.github.io/FsFlow/reference/diagnostics/m-diagnosticsmodule-tostring/ <p>Renders a diagnostics graph in a YAML-like layout for display.</p> <h2 id="remarks">Remarks</h2> <p>This is intended for human-readable output. Empty sections are omitted, and children are shown directly under their branch labels at the same indentation level as errors. Errors render as YAML-style bullet items without an <code>Errors:</code> key. Use <code>flatten</code> when you need path-bearing diagnostics for reporting or assertions.</p> <h2 id="parameters">Parameters</h2> <ul> <li><code>graph</code>: The diagnostics graph to render.</li> </ul> <h2 id="returns">Returns</h2> <p>A formatted string representation of the graph.</p>