Struct DiagnosticMessageHandler<TLevel>

Namespace

SwiftCollections.Diagnostics

Assembly

SwiftCollections.dll

Builds interpolated diagnostic messages only when the requested diagnostic level is enabled.

public ref struct DiagnosticMessageHandler<TLevel> where TLevel : struct, IDiagnosticLevelProvider

Type Parameters

TLevel

The fixed diagnostic level provider used by fixed-level helpers.

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.GetType()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

DiagnosticMessageHandler(int, int, DiagnosticChannel, DiagnosticLevel, out bool)

Initializes a new handler for a dynamic-level diagnostic message.

public DiagnosticMessageHandler(int literalLength, int formattedCount, DiagnosticChannel channel, DiagnosticLevel level, out bool isEnabled)

Parameters

literalLength int

The combined length of literal portions in the interpolated string.

formattedCount int

The number of formatted expressions in the interpolated string.

channel DiagnosticChannel

The diagnostic channel that receives the message.

level DiagnosticLevel

The diagnostic level being evaluated.

isEnabled bool

Set to true when formatted expressions should be evaluated.

DiagnosticMessageHandler(int, int, DiagnosticChannel, out bool)

Initializes a new handler for a fixed-level diagnostic message.

public DiagnosticMessageHandler(int literalLength, int formattedCount, DiagnosticChannel channel, out bool isEnabled)

Parameters

literalLength int

The combined length of literal portions in the interpolated string.

formattedCount int

The number of formatted expressions in the interpolated string.

channel DiagnosticChannel

The diagnostic channel that receives the message.

isEnabled bool

Set to true when formatted expressions should be evaluated.

Properties

IsEnabled

Gets whether the handler is actively building a diagnostic message.

public bool IsEnabled { get; }

Property Value

bool

Methods

AppendFormatted<T>(T)

Appends a formatted value.

public void AppendFormatted<T>(T value)

Parameters

value T

The value to append.

Type Parameters

T

The type of value to append.

AppendFormatted<T>(T, int)

Appends a formatted value with the specified alignment.

public void AppendFormatted<T>(T value, int alignment)

Parameters

value T

The value to append.

alignment int

The minimum width for the formatted value.

Type Parameters

T

The type of value to append.

AppendFormatted<T>(T, int, string)

Appends a formatted value with the specified alignment and format string.

public void AppendFormatted<T>(T value, int alignment, string format)

Parameters

value T

The value to append.

alignment int

The minimum width for the formatted value.

format string

The format string to apply.

Type Parameters

T

The type of value to append.

AppendFormatted<T>(T, string)

Appends a formatted value using the specified format string.

public void AppendFormatted<T>(T value, string format)

Parameters

value T

The value to append.

format string

The format string to apply.

Type Parameters

T

The type of value to append.

AppendLiteral(string)

Appends a literal string segment.

public void AppendLiteral(string value)

Parameters

value string

The literal string segment.