Class PluginDiagnosticReference

Namespace

DotBoxD.Plugins.Runtime.Diagnostics

Assembly

DotBoxD.Plugins.dll

Public reference entry for a single runtime plugin diagnostic Code emitted by the DotBoxD.Plugins package.

public sealed record PluginDiagnosticReference : IEquatable<PluginDiagnosticReference>

Inheritance

object

PluginDiagnosticReference

Implements

IEquatable<PluginDiagnosticReference>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

PluginDiagnosticReference(string, PluginDiagnosticPhase, PluginDiagnosticAudience, string, string, string)

Public reference entry for a single runtime plugin diagnostic Code emitted by the DotBoxD.Plugins package.

public PluginDiagnosticReference(string Code, PluginDiagnosticPhase Phase, PluginDiagnosticAudience Audience, string Meaning, string LikelyCause, string Remediation)

Parameters

Code string

The stable DBXK* diagnostic code.

Phase PluginDiagnosticPhase

The runtime phase that emits the code.

Audience PluginDiagnosticAudience

Who must act on the diagnostic.

Meaning string

A short human-readable description of the rule that was violated.

LikelyCause string

The most common reason this code is emitted.

Remediation string

Guidance for the plugin author or host operator investigating the code.

Properties

Audience

Who must act on the diagnostic.

public PluginDiagnosticAudience Audience { get; init; }

Property Value

PluginDiagnosticAudience

Code

The stable DBXK* diagnostic code.

public string Code { get; init; }

Property Value

string

LikelyCause

The most common reason this code is emitted.

public string LikelyCause { get; init; }

Property Value

string

Meaning

A short human-readable description of the rule that was violated.

public string Meaning { get; init; }

Property Value

string

Phase

The runtime phase that emits the code.

public PluginDiagnosticPhase Phase { get; init; }

Property Value

PluginDiagnosticPhase

Remediation

Guidance for the plugin author or host operator investigating the code.

public string Remediation { get; init; }

Property Value

string