mrdocs::report

Reporting utilities (messages, statistics, sinks).

Description

The report namespace owns severity enums, message structs, and output sinks so tooling and libraries emit diagnostics in a uniform, testable format regardless of UI.

Types

Name

Description

Located

Parameter type that adds a source location to a value.

Results

Provides statistics on the number of reported messages.

Enums

Name

Description

Level

Severity levels attached to reported messags.

Functions

Name

Description

debug

Emit a debug‐level diagnostic for troubleshooting.

error

Emit an error that indicates failure but allows continuation.

fatal

Emit a fatal error and mark the report as the highest severity.

getMinimumLevel

Get the minimum threshold level for reporting.

info

Emit an informational message for users.

log

Format a message to the console.

print

Report a message to the console.

setMinimumLevel

Set the minimum threshold level for reporting.

setSourceLocationWarnings

If true, source location information will be printed with warnings, errors, and fatal messages.

trace

Emit a trace‐level diagnostic (verbose, off by default).

warn

Emit a warning that does not stop execution.

Variables

Name

Description

results

Holds current statistics on reported messages.

Created with MrDocs