1. Home
  2. API
  3. XenoAtom.CommandLine
  4. CommandDiagnostic

CommandDiagnostic Struct

Definition

Assembly XenoAtom.CommandLine.dll
View source
Show inherited members (6)

Provides optional structured diagnostic context for rich error rendering.

public readonly record struct CommandDiagnostic(CommandDiagnosticSource Source, string? SourceName, CommandNode? Node, IReadOnlyList<string>? Tokens, CommandTokenSpan? TokenSpan) : IEquatable<CommandDiagnostic>

Remarks

This data is intended for presentation only (for example re-printing the invocation and underlining a token). It must not include secret values.

Tip: use kind:method, kind:property, kind:ctor. Press Esc to clear.

Constructors (1)

CommandDiagnostic(CommandDiagnosticSource, String?, CommandNode?, IReadOnlyList<String>?, Nullable<CommandTokenSpan>)Provides optional structured diagnostic context for rich error rendering.

Properties (5)

NodeThe associated command node, when available.
SourceThe origin of the diagnostic value.
SourceNameAn optional source name (for example environment variable name or response-file name).
TokensThe original invocation tokens, when available.
TokenSpanThe location of the relevant token span, when available.