Class DiagnosticBag

Namespace

Utils.Parser.Diagnostics

Assembly

Utils.Parser.Diagnostics.dll

Mutable collection of parser diagnostics.

public sealed class DiagnosticBag : IReadOnlyCollection<ParserDiagnostic>, IEnumerable<ParserDiagnostic>, IEnumerable

Inheritance

object

DiagnosticBag

Implements

IReadOnlyCollection<ParserDiagnostic>

IEnumerable<ParserDiagnostic>

IEnumerable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

DataUtils.ToDbValue(object?)

MathEx.Clamp<T>(T, T, T, IComparer<T>)

FluentExtensions.Failure<T>(T)

FluentExtensions.IsEqualTo<T, CT>(T, CT)

FluentExtensions.IsGreaterOrEqualsThan<T, CT>(T, CT)

FluentExtensions.IsGreaterThan<T, CT>(T, CT)

FluentExtensions.IsIn<T>(T, params T[])

FluentExtensions.IsLowerOrEqualsThan<T, CT>(T, CT)

FluentExtensions.IsLowerThan<T, CT>(T, CT)

FluentExtensions.IsNotIn<T>(T, params T[])

FluentExtensions.IsNotNull<T>(T)

FluentExtensions.IsNull<T>(T)

FluentExtensions.Success<T>(T)

FluentExtensions.Test<T>(T, Func<T, bool>)

ObjectUtils.Between<T>(T, IComparer<T>, T, T)

ObjectUtils.Between<T>(T, IComparer<T>, T, T, bool, bool)

ObjectUtils.DoAsync<T, Result>(T, Func<T, Task<Result>>, Func<Task<Result>>)

ObjectUtils.DoAsync<T, Result>(T, Func<T, Task<Result>>, Result)

ObjectUtils.DoAsync<T, Result>(T, Func<T, Result>, Func<Result>)

ObjectUtils.DoAsync<T, Result>(T, Func<T, Result>, Result)

ObjectUtils.Do<T, Result>(T, Func<T, Result>, Func<Result>)

ObjectUtils.Do<T, Result>(T, Func<T, Result>, Result)

ObjectUtils.In<T>(T, params T[])

ObjectUtils.NotIn<T>(T, params T[])

Validations.ArgMustBe<T>(T, Func<T, bool>, string, string)

Validations.ArgMustNotBe<T>(T, Func<T, bool>, string, string)

Validations.Arg<T>(T, string)

Validations.ValueMustNotBeNull<T>(T, string)

Validations.Variable<T>(T, string)

Properties

Count

Gets the total diagnostic count.

public int Count { get; }

Property Value

int

HasErrors

Gets a value indicating whether at least one error diagnostic is present.

public bool HasErrors { get; }

Property Value

bool

Methods

Add(ParserDiagnostic)

Adds a diagnostic instance to the bag.

public void Add(ParserDiagnostic diagnostic)

Parameters

diagnostic ParserDiagnostic

Diagnostic to add.

Add(ParserDiagnosticDescriptor, params object?[])

Creates and adds a diagnostic from a descriptor.

public ParserDiagnostic Add(ParserDiagnosticDescriptor descriptor, params object?[] arguments)

Parameters

descriptor ParserDiagnosticDescriptor

Diagnostic descriptor.

arguments object[]

Message format arguments.

Returns

ParserDiagnostic

The added diagnostic.

AddRange(IEnumerable<ParserDiagnostic>)

Adds all diagnostics from another sequence.

public void AddRange(IEnumerable<ParserDiagnostic> diagnostics)

Parameters

diagnostics IEnumerable<ParserDiagnostic>

Diagnostics to append.

AddWithContext(ParserDiagnosticDescriptor, int?, int?, string?, Exception?, params object?[])

Creates and adds a diagnostic from a descriptor with contextual information.

public ParserDiagnostic AddWithContext(ParserDiagnosticDescriptor descriptor, int? spanStart, int? spanLength, string? ruleName, Exception? exception, params object?[] arguments)

Parameters

descriptor ParserDiagnosticDescriptor

Diagnostic descriptor.

spanStart int?

Optional source span start.

spanLength int?

Optional source span length.

ruleName string

Optional rule context.

exception Exception

Optional related exception.

arguments object[]

Message format arguments.

Returns

ParserDiagnostic

The added diagnostic.

AddWithStructuredContext(ParserDiagnosticDescriptor, DiagnosticSpan?, SourceCodeLocation?, string?, Exception?, params object?[])

Creates and adds a diagnostic from a descriptor with composed context objects.

public ParserDiagnostic AddWithStructuredContext(ParserDiagnosticDescriptor descriptor, DiagnosticSpan? span, SourceCodeLocation? location, string? ruleName, Exception? exception, params object?[] arguments)

Parameters

descriptor ParserDiagnosticDescriptor

Diagnostic descriptor.

span DiagnosticSpan

Optional source span.

location SourceCodeLocation

Optional source location.

ruleName string

Optional rule context.

exception Exception

Optional related exception.

arguments object[]

Message format arguments.

Returns

ParserDiagnostic

The added diagnostic.

GetAtLeast(DiagnosticSeverity)

Gets all diagnostics whose severity is at least as important as severity.

public IReadOnlyList<ParserDiagnostic> GetAtLeast(DiagnosticSeverity severity)

Parameters

severity DiagnosticSeverity

Minimum severity threshold.

Returns

IReadOnlyList<ParserDiagnostic>

Filtered diagnostics.

GetEnumerator()

public IEnumerator<ParserDiagnostic> GetEnumerator()

Returns

IEnumerator<ParserDiagnostic>

ToList()

Returns a read-only snapshot of the diagnostics.

public IReadOnlyList<ParserDiagnostic> ToList()

Returns

IReadOnlyList<ParserDiagnostic>

Snapshot list.