Archived
deploy webservice static-file routing for docsite folder URLs, per-instance step-cache db, and constant-height panel title bars.
This commit is contained in:
@@ -6,7 +6,7 @@
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Class NcDiagnostic | HiAPI-C# 2025 ">
|
||||
|
||||
<meta name="description" content="A structured diagnostic from the pipeline, designed for consumption. is composed as {Primary}-{Secondary}--{Abbrev} (e.g., Cycle-Peck--BadPeckQ, Syntax-Build--Exception). For irregular cases that don't fit the pattern, use a custom string.">
|
||||
<meta name="description" content="A structured diagnostic from the pipeline, designed for consumption. Implements so it shares the common message channel with , step diagnostics, and progress fractions, while additionally carrying an NC-source anchor that non-NC messages do not have. Also an itself — and delegate to so a diagnostic can be used directly anywhere a carrier is expected, without the consumer unwrapping the inner anchor. is composed as {Primary}-{Secondary}--{Abbrev} (e.g., Cycle-Peck--BadPeckQ, Syntax-Build--Exception). For irregular cases that don't fit the pattern, use a custom string.">
|
||||
<link rel="icon" href="../img/HiAPI.favicon.ico">
|
||||
<link rel="stylesheet" href="../public/docfx.min.css">
|
||||
<link rel="stylesheet" href="../public/main.css">
|
||||
@@ -98,7 +98,17 @@ Class NcDiagnostic
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>A structured diagnostic from the <a class="xref" href="Hi.NcParsers.SoftNcRunner.html">SoftNcRunner</a> pipeline,
|
||||
designed for <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iprogress-1">IProgress<T></a> consumption.</p>
|
||||
designed for <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iprogress-1">IProgress<T></a> consumption. Implements
|
||||
<a class="xref" href="Hi.Common.Messages.IMessage.html">IMessage</a> so it shares the common message channel with
|
||||
<a class="xref" href="Hi.Common.Messages.SimpleMessage.html">SimpleMessage</a>, step diagnostics, and progress fractions, while
|
||||
additionally carrying an NC-source <a class="xref" href="Hi.NcParsers.NcDiagnostic.html#Hi_NcParsers_NcDiagnostic_SentenceCarrier">SentenceCarrier</a> anchor that
|
||||
non-NC messages do not have.</p>
|
||||
<p>
|
||||
Also an <a class="xref" href="Hi.NcParsers.ISentenceCarrier.html">ISentenceCarrier</a> itself — <a class="xref" href="Hi.NcParsers.NcDiagnostic.html#Hi_NcParsers_NcDiagnostic_GetSentence">GetSentence()</a> and
|
||||
<a class="xref" href="Hi.NcParsers.NcDiagnostic.html#Hi_NcParsers_NcDiagnostic_SentenceIndex">SentenceIndex</a> delegate to <a class="xref" href="Hi.NcParsers.NcDiagnostic.html#Hi_NcParsers_NcDiagnostic_SentenceCarrier">SentenceCarrier</a> so a
|
||||
diagnostic can be used directly anywhere a carrier is expected, without the
|
||||
consumer unwrapping the inner anchor.
|
||||
</p>
|
||||
<p>
|
||||
<a class="xref" href="Hi.NcParsers.NcDiagnostic.html#Hi_NcParsers_NcDiagnostic_Id">Id</a> is composed as <code>{Primary}-{Secondary}--{Abbrev}</code>
|
||||
(e.g., <code>Cycle-Peck--BadPeckQ</code>, <code>Syntax-Build--Exception</code>).
|
||||
@@ -108,7 +118,7 @@ For irregular cases that don't fit the pattern, use a custom string.
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class NcDiagnostic</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public class NcDiagnostic : IMessage, ISentenceCarrier, IGetSentence, ISentenceIndexed</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
@@ -122,6 +132,15 @@ For irregular cases that don't fit the pattern, use a custom string.
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<dl class="typelist implements">
|
||||
<dt>Implements</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="Hi.Common.Messages.IMessage.html">IMessage</a></div>
|
||||
<div><a class="xref" href="Hi.NcParsers.ISentenceCarrier.html">ISentenceCarrier</a></div>
|
||||
<div><a class="xref" href="Hi.NcParsers.IGetSentence.html">IGetSentence</a></div>
|
||||
<div><a class="xref" href="Hi.NcParsers.ISentenceIndexed.html">ISentenceIndexed</a></div>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
<dl class="typelist inheritedMembers">
|
||||
@@ -183,8 +202,60 @@ For irregular cases that don't fit the pattern, use a custom string.
|
||||
|
||||
<a id="Hi_NcParsers_NcDiagnostic__ctor_" data-uid="Hi.NcParsers.NcDiagnostic.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_NcDiagnostic__ctor_Hi_NcParsers_NcDiagnosticSeverity_Hi_NcParsers_NcDiagnosticCategory_System_String_System_String_System_Object_Hi_NcParsers_ISentenceCarrier_" data-uid="Hi.NcParsers.NcDiagnostic.#ctor(Hi.NcParsers.NcDiagnosticSeverity,Hi.NcParsers.NcDiagnosticCategory,System.String,System.String,System.Object,Hi.NcParsers.ISentenceCarrier)">
|
||||
NcDiagnostic(NcDiagnosticSeverity, NcDiagnosticCategory, string, string, object, ISentenceCarrier)
|
||||
<h3 id="Hi_NcParsers_NcDiagnostic__ctor_Hi_Common_Messages_Severity_Hi_Common_Messages_Category_System_String_System_FormattableString_System_Object_Hi_NcParsers_ISentenceCarrier_" data-uid="Hi.NcParsers.NcDiagnostic.#ctor(Hi.Common.Messages.Severity,Hi.Common.Messages.Category,System.String,System.FormattableString,System.Object,Hi.NcParsers.ISentenceCarrier)">
|
||||
NcDiagnostic(Severity, Category, string, FormattableString, object, ISentenceCarrier)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Creates a templated <a class="xref" href="Hi.NcParsers.NcDiagnostic.html">NcDiagnostic</a>: the interpolated template and its values
|
||||
are kept on <a class="xref" href="Hi.NcParsers.NcDiagnostic.html#Hi_NcParsers_NcDiagnostic_Format">Format</a> / <a class="xref" href="Hi.NcParsers.NcDiagnostic.html#Hi_NcParsers_NcDiagnostic_Args">Args</a> and <a class="xref" href="Hi.NcParsers.NcDiagnostic.html#Hi_NcParsers_NcDiagnostic_Notification">Notification</a>
|
||||
becomes the culture-invariant English rendering. An interpolated string literal passed to
|
||||
the <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a> constructor is NOT captured here — call sites opt in through the
|
||||
<code>*Fmt</code> methods on <a class="xref" href="Hi.NcParsers.NcDiagnosticProgress.html">NcDiagnosticProgress</a>.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public NcDiagnostic(Severity severity, Category category, string id, FormattableString notification, object detail = null, ISentenceCarrier sentenceCarrier = null)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>severity</code> <a class="xref" href="Hi.Common.Messages.Severity.html">Severity</a></dt>
|
||||
<dd><p>Importance level — see <a class="xref" href="Hi.Common.Messages.Severity.html">Severity</a>.</p>
|
||||
</dd>
|
||||
<dt><code>category</code> <a class="xref" href="Hi.Common.Messages.Category.html">Category</a></dt>
|
||||
<dd><p>Diagnostic category — see <a class="xref" href="Hi.Common.Messages.Category.html">Category</a>.</p>
|
||||
</dd>
|
||||
<dt><code>id</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>Structured diagnostic ID (see <a class="xref" href="Hi.NcParsers.NcDiagnostic.html#Hi_NcParsers_NcDiagnostic_Id">Id</a>).</p>
|
||||
</dd>
|
||||
<dt><code>notification</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.formattablestring">FormattableString</a></dt>
|
||||
<dd><p>Interpolated notification template.</p>
|
||||
</dd>
|
||||
<dt><code>detail</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></dt>
|
||||
<dd><p>Optional detail data or exception. Null if not applicable.</p>
|
||||
</dd>
|
||||
<dt><code>sentenceCarrier</code> <a class="xref" href="Hi.NcParsers.ISentenceCarrier.html">ISentenceCarrier</a></dt>
|
||||
<dd><p>Carrier for the NC source block that triggered this diagnostic; null for pipeline-level messages.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_NcDiagnostic__ctor_" data-uid="Hi.NcParsers.NcDiagnostic.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_NcDiagnostic__ctor_Hi_Common_Messages_Severity_Hi_Common_Messages_Category_System_String_System_String_System_Object_Hi_NcParsers_ISentenceCarrier_" data-uid="Hi.NcParsers.NcDiagnostic.#ctor(Hi.Common.Messages.Severity,Hi.Common.Messages.Category,System.String,System.String,System.Object,Hi.NcParsers.ISentenceCarrier)">
|
||||
NcDiagnostic(Severity, Category, string, string, object, ISentenceCarrier)
|
||||
|
||||
</h3>
|
||||
|
||||
@@ -193,22 +264,78 @@ For irregular cases that don't fit the pattern, use a custom string.
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public NcDiagnostic(NcDiagnosticSeverity severity, NcDiagnosticCategory category, string id, string text, object detail = null, ISentenceCarrier sentenceCarrier = null)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public NcDiagnostic(Severity severity, Category category, string id, string notification, object detail = null, ISentenceCarrier sentenceCarrier = null)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>severity</code> <a class="xref" href="Hi.NcParsers.NcDiagnosticSeverity.html">NcDiagnosticSeverity</a></dt>
|
||||
<dd><p>Importance level — see <a class="xref" href="Hi.NcParsers.NcDiagnosticSeverity.html">NcDiagnosticSeverity</a>.</p>
|
||||
<dt><code>severity</code> <a class="xref" href="Hi.Common.Messages.Severity.html">Severity</a></dt>
|
||||
<dd><p>Importance level — see <a class="xref" href="Hi.Common.Messages.Severity.html">Severity</a>.</p>
|
||||
</dd>
|
||||
<dt><code>category</code> <a class="xref" href="Hi.NcParsers.NcDiagnosticCategory.html">NcDiagnosticCategory</a></dt>
|
||||
<dd><p>Diagnostic category — see <a class="xref" href="Hi.NcParsers.NcDiagnosticCategory.html">NcDiagnosticCategory</a>.</p>
|
||||
<dt><code>category</code> <a class="xref" href="Hi.Common.Messages.Category.html">Category</a></dt>
|
||||
<dd><p>Diagnostic category — see <a class="xref" href="Hi.Common.Messages.Category.html">Category</a>.</p>
|
||||
</dd>
|
||||
<dt><code>id</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>Structured diagnostic ID (see <a class="xref" href="Hi.NcParsers.NcDiagnostic.html#Hi_NcParsers_NcDiagnostic_Id">Id</a>).</p>
|
||||
</dd>
|
||||
<dt><code>text</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>End-user friendly message text.</p>
|
||||
<dt><code>notification</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>End-user friendly notification text.</p>
|
||||
</dd>
|
||||
<dt><code>detail</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></dt>
|
||||
<dd><p>Optional detail data or exception. Null if not applicable.</p>
|
||||
</dd>
|
||||
<dt><code>sentenceCarrier</code> <a class="xref" href="Hi.NcParsers.ISentenceCarrier.html">ISentenceCarrier</a></dt>
|
||||
<dd><p>Carrier for the NC source block that triggered this diagnostic; null for pipeline-level messages.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_NcDiagnostic__ctor_" data-uid="Hi.NcParsers.NcDiagnostic.#ctor*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_NcDiagnostic__ctor_Hi_Common_Messages_Severity_Hi_Common_Messages_Category_System_String_System_String_System_String_System_Object___System_Object_Hi_NcParsers_ISentenceCarrier_" data-uid="Hi.NcParsers.NcDiagnostic.#ctor(Hi.Common.Messages.Severity,Hi.Common.Messages.Category,System.String,System.String,System.String,System.Object[],System.Object,Hi.NcParsers.ISentenceCarrier)">
|
||||
NcDiagnostic(Severity, Category, string, string, string, object[], object, ISentenceCarrier)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Creates an <a class="xref" href="Hi.NcParsers.NcDiagnostic.html">NcDiagnostic</a> carrying an already-split template — used when
|
||||
re-wrapping another <a class="xref" href="Hi.Common.Messages.IMessage.html">IMessage</a> whose format / args must survive (e.g.
|
||||
<a class="xref" href="Hi.NcParsers.NcDiagnosticProgress.html#Hi_NcParsers_NcDiagnosticProgress_AsMessageSink_Hi_NcParsers_ISentenceCarrier_">AsMessageSink(ISentenceCarrier)</a>) instead of re-interpolating.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public NcDiagnostic(Severity severity, Category category, string id, string notification, string format, object[] args, object detail = null, ISentenceCarrier sentenceCarrier = null)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>severity</code> <a class="xref" href="Hi.Common.Messages.Severity.html">Severity</a></dt>
|
||||
<dd><p>Importance level — see <a class="xref" href="Hi.Common.Messages.Severity.html">Severity</a>.</p>
|
||||
</dd>
|
||||
<dt><code>category</code> <a class="xref" href="Hi.Common.Messages.Category.html">Category</a></dt>
|
||||
<dd><p>Diagnostic category — see <a class="xref" href="Hi.Common.Messages.Category.html">Category</a>.</p>
|
||||
</dd>
|
||||
<dt><code>id</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>Structured diagnostic ID (see <a class="xref" href="Hi.NcParsers.NcDiagnostic.html#Hi_NcParsers_NcDiagnostic_Id">Id</a>).</p>
|
||||
</dd>
|
||||
<dt><code>notification</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>Already-rendered notification text.</p>
|
||||
</dd>
|
||||
<dt><code>format</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>Composite-format template behind <code class="paramref">notification</code>; null when untemplated.</p>
|
||||
</dd>
|
||||
<dt><code>args</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</dt>
|
||||
<dd><p>Values interpolated into <code class="paramref">format</code>; null when untemplated.</p>
|
||||
</dd>
|
||||
<dt><code>detail</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></dt>
|
||||
<dd><p>Optional detail data or exception. Null if not applicable.</p>
|
||||
@@ -233,6 +360,38 @@ For irregular cases that don't fit the pattern, use a custom string.
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_NcDiagnostic_Args_" data-uid="Hi.NcParsers.NcDiagnostic.Args*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_NcDiagnostic_Args" data-uid="Hi.NcParsers.NcDiagnostic.Args">
|
||||
Args
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Values interpolated into <a class="xref" href="Hi.NcParsers.NcDiagnostic.html#Hi_NcParsers_NcDiagnostic_Format">Format</a>; null when untemplated.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public object[] Args { get; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_NcDiagnostic_Category_" data-uid="Hi.NcParsers.NcDiagnostic.Category*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_NcDiagnostic_Category" data-uid="Hi.NcParsers.NcDiagnostic.Category">
|
||||
@@ -245,7 +404,7 @@ For irregular cases that don't fit the pattern, use a custom string.
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public NcDiagnosticCategory Category { get; }</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public Category Category { get; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
@@ -254,7 +413,7 @@ For irregular cases that don't fit the pattern, use a custom string.
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="Hi.NcParsers.NcDiagnosticCategory.html">NcDiagnosticCategory</a></dt>
|
||||
<dt><a class="xref" href="Hi.Common.Messages.Category.html">Category</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
@@ -297,6 +456,39 @@ For irregular cases that don't fit the pattern, use a custom string.
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_NcDiagnostic_Format_" data-uid="Hi.NcParsers.NcDiagnostic.Format*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_NcDiagnostic_Format" data-uid="Hi.NcParsers.NcDiagnostic.Format">
|
||||
Format
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Composite-format template behind <a class="xref" href="Hi.NcParsers.NcDiagnostic.html#Hi_NcParsers_NcDiagnostic_Notification">Notification</a>; null when the diagnostic
|
||||
was built from a plain string (untemplated).</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public string Format { get; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_NcDiagnostic_Id_" data-uid="Hi.NcParsers.NcDiagnostic.Id*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_NcDiagnostic_Id" data-uid="Hi.NcParsers.NcDiagnostic.Id">
|
||||
@@ -305,7 +497,7 @@ For irregular cases that don't fit the pattern, use a custom string.
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Structured diagnostic ID for filtering and suppression.
|
||||
Normally <code>{Primary}-{Secondary}–{Serial:000}</code>.</p>
|
||||
Normally <code>{Primary}-{Secondary}–{Abbrev}</code>.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
@@ -330,6 +522,38 @@ Normally <code>{Primary}-{Secondary}–{Serial:000}</code>.</p>
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_NcDiagnostic_Notification_" data-uid="Hi.NcParsers.NcDiagnostic.Notification*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_NcDiagnostic_Notification" data-uid="Hi.NcParsers.NcDiagnostic.Notification">
|
||||
Notification
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>End-user friendly notification text.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public string Notification { get; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_NcDiagnostic_SentenceCarrier_" data-uid="Hi.NcParsers.NcDiagnostic.SentenceCarrier*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_NcDiagnostic_SentenceCarrier" data-uid="Hi.NcParsers.NcDiagnostic.SentenceCarrier">
|
||||
@@ -366,6 +590,41 @@ messages (e.g., lifecycle start/done) that have no source block.</p>
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_NcDiagnostic_SentenceIndex_" data-uid="Hi.NcParsers.NcDiagnostic.SentenceIndex*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_NcDiagnostic_SentenceIndex" data-uid="Hi.NcParsers.NcDiagnostic.SentenceIndex">
|
||||
SentenceIndex
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Execution-order ordinal of the anchored NC source block, delegated from
|
||||
<a class="xref" href="Hi.NcParsers.NcDiagnostic.html#Hi_NcParsers_NcDiagnostic_SentenceCarrier">SentenceCarrier</a>. Returns <code>-1</code> (the “not in pipeline”
|
||||
sentinel) for pipeline-level messages whose <a class="xref" href="Hi.NcParsers.NcDiagnostic.html#Hi_NcParsers_NcDiagnostic_SentenceCarrier">SentenceCarrier</a>
|
||||
is null.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public int SentenceIndex { get; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_NcDiagnostic_Severity_" data-uid="Hi.NcParsers.NcDiagnostic.Severity*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_NcDiagnostic_Severity" data-uid="Hi.NcParsers.NcDiagnostic.Severity">
|
||||
@@ -378,7 +637,7 @@ messages (e.g., lifecycle start/done) that have no source block.</p>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public NcDiagnosticSeverity Severity { get; }</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public Severity Severity { get; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
@@ -387,39 +646,7 @@ messages (e.g., lifecycle start/done) that have no source block.</p>
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="Hi.NcParsers.NcDiagnosticSeverity.html">NcDiagnosticSeverity</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_NcDiagnostic_Text_" data-uid="Hi.NcParsers.NcDiagnostic.Text*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_NcDiagnostic_Text" data-uid="Hi.NcParsers.NcDiagnostic.Text">
|
||||
Text
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>End-user friendly message text.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public string Text { get; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dt><a class="xref" href="Hi.Common.Messages.Severity.html">Severity</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
@@ -434,6 +661,279 @@ messages (e.g., lifecycle start/done) that have no source block.</p>
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_NcDiagnostic_GetArgs_" data-uid="Hi.NcParsers.NcDiagnostic.GetArgs*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_NcDiagnostic_GetArgs" data-uid="Hi.NcParsers.NcDiagnostic.GetArgs">
|
||||
GetArgs()
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Gets the values interpolated into <a class="xref" href="Hi.Common.Messages.IMessage.html#Hi_Common_Messages_IMessage_GetFormat">GetFormat()</a>; null when
|
||||
<a class="xref" href="Hi.Common.Messages.IMessage.html#Hi_Common_Messages_IMessage_GetFormat">GetFormat()</a> is null, possibly empty for a hole-less template.
|
||||
Default interface method so external implementers are unaffected.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public object[] GetArgs()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</dt>
|
||||
<dd><p>The interpolation arguments, or null when untemplated.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_NcDiagnostic_GetCategory_" data-uid="Hi.NcParsers.NcDiagnostic.GetCategory*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_NcDiagnostic_GetCategory" data-uid="Hi.NcParsers.NcDiagnostic.GetCategory">
|
||||
GetCategory()
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Gets the classification — see <a class="xref" href="Hi.Common.Messages.Category.html">Category</a>.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public Category GetCategory()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="Hi.Common.Messages.Category.html">Category</a></dt>
|
||||
<dd><p>The category of this message.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_NcDiagnostic_GetDetail_" data-uid="Hi.NcParsers.NcDiagnostic.GetDetail*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_NcDiagnostic_GetDetail" data-uid="Hi.NcParsers.NcDiagnostic.GetDetail">
|
||||
GetDetail()
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Gets the optional detail payload or exception; null when not applicable.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public object GetDetail()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></dt>
|
||||
<dd><p>The detail object, or null.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_NcDiagnostic_GetFormat_" data-uid="Hi.NcParsers.NcDiagnostic.GetFormat*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_NcDiagnostic_GetFormat" data-uid="Hi.NcParsers.NcDiagnostic.GetFormat">
|
||||
GetFormat()
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Gets the composite-format template behind <a class="xref" href="Hi.Common.Messages.IMessage.html#Hi_Common_Messages_IMessage_GetNotification">GetNotification()</a> — a
|
||||
<code>{0}</code>-style .NET format string — when this message was produced from an
|
||||
interpolated template; null when the notification has no structured template.
|
||||
Together with <a class="xref" href="Hi.Common.Messages.IMessage.html#Hi_Common_Messages_IMessage_GetArgs">GetArgs()</a> this lets a consumer re-render the message
|
||||
in another language without losing the interpolated live values, while
|
||||
<a class="xref" href="Hi.Common.Messages.IMessage.html#Hi_Common_Messages_IMessage_GetNotification">GetNotification()</a> stays the invariant English rendering.
|
||||
Default interface method so external implementers are unaffected.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public string GetFormat()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>The composite format string, or null when untemplated.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_NcDiagnostic_GetId_" data-uid="Hi.NcParsers.NcDiagnostic.GetId*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_NcDiagnostic_GetId" data-uid="Hi.NcParsers.NcDiagnostic.GetId">
|
||||
GetId()
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Gets the structured id used for filtering / suppression; may be null.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public string GetId()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>The message id, or null when not applicable.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_NcDiagnostic_GetNotification_" data-uid="Hi.NcParsers.NcDiagnostic.GetNotification*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_NcDiagnostic_GetNotification" data-uid="Hi.NcParsers.NcDiagnostic.GetNotification">
|
||||
GetNotification()
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Gets the end-user friendly notification text.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public string GetNotification()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>The notification text.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_NcDiagnostic_GetSentence_" data-uid="Hi.NcParsers.NcDiagnostic.GetSentence*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_NcDiagnostic_GetSentence" data-uid="Hi.NcParsers.NcDiagnostic.GetSentence">
|
||||
GetSentence()
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Returns the anchored NC source <a class="xref" href="Hi.NcParsers.Sentence.html">Sentence</a>, delegated from
|
||||
<a class="xref" href="Hi.NcParsers.NcDiagnostic.html#Hi_NcParsers_NcDiagnostic_SentenceCarrier">SentenceCarrier</a>; null when there is no source block
|
||||
(pipeline-level messages).</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public Sentence GetSentence()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="Hi.NcParsers.Sentence.html">Sentence</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_NcDiagnostic_GetSeverity_" data-uid="Hi.NcParsers.NcDiagnostic.GetSeverity*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_NcDiagnostic_GetSeverity" data-uid="Hi.NcParsers.NcDiagnostic.GetSeverity">
|
||||
GetSeverity()
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Gets the importance level — see <a class="xref" href="Hi.Common.Messages.Severity.html">Severity</a>.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public Severity GetSeverity()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="Hi.Common.Messages.Severity.html">Severity</a></dt>
|
||||
<dd><p>The severity of this message.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="Hi_NcParsers_NcDiagnostic_ToString_" data-uid="Hi.NcParsers.NcDiagnostic.ToString*"></a>
|
||||
|
||||
<h3 id="Hi_NcParsers_NcDiagnostic_ToString" data-uid="Hi.NcParsers.NcDiagnostic.ToString">
|
||||
|
||||
Reference in New Issue
Block a user