Class ProtoReportItem

Namespace

ProtoTest.Core

Assembly

ProtoTest.Core.dll

A normalized item that can be rendered by any report sink. Kind is an open string so integrations can define their own; ProtoReportItemKinds names the values Core itself uses.

public sealed record ProtoReportItem : IEquatable<ProtoReportItem>

Inheritance

object

ProtoReportItem

Implements

IEquatable<ProtoReportItem>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

ProtoReportItemExtensions.Flatten(ProtoReportItem)

ProtoReportItemExtensions.IsKind(ProtoReportItem, string)

SheetModelAssertions.ShouldMatchShape<TRow>(TRow, object, JsonSerializerOptions?)

Constructors

ProtoReportItem(string, string, string, string, ProtoReportStatus, int, bool?, double?, string?, string?, IReadOnlyList<string>?, IReadOnlyList<ProtoReportItem>?, IReadOnlyDictionary<string, object>?, string?, string?)

A normalized item that can be rendered by any report sink. Kind is an open string so integrations can define their own; ProtoReportItemKinds names the values Core itself uses.

public ProtoReportItem(string TargetName, string Category, string Identifier, string Kind = "observation", ProtoReportStatus Status = ProtoReportStatus.Neutral, int Count = 0, bool? IsCovered = null, double? Value = null, string? Unit = null, string? Message = null, IReadOnlyList<string>? Tags = null, IReadOnlyList<ProtoReportItem>? Children = null, IReadOnlyDictionary<string, object>? Metadata = null, string? DisplayName = null, string? DisplayGroup = null)

Parameters

TargetName string

Category string

Identifier string

Kind string

Status ProtoReportStatus

Count int

IsCovered bool?

Value double?

Unit string

Message string

Tags IReadOnlyList<string>

Children IReadOnlyList<ProtoReportItem>

Metadata IReadOnlyDictionary<string, object>

DisplayName string

DisplayGroup string

Properties

Category

public string Category { get; init; }

Property Value

string

Children

public IReadOnlyList<ProtoReportItem>? Children { get; init; }

Property Value

IReadOnlyList<ProtoReportItem>

Count

public int Count { get; init; }

Property Value

int

DisplayGroup

public string? DisplayGroup { get; init; }

Property Value

string

DisplayName

public string? DisplayName { get; init; }

Property Value

string

Identifier

public string Identifier { get; init; }

Property Value

string

IsCovered

public bool? IsCovered { get; init; }

Property Value

bool?

Kind

public string Kind { get; init; }

Property Value

string

Message

public string? Message { get; init; }

Property Value

string

Metadata

public IReadOnlyDictionary<string, object>? Metadata { get; init; }

Property Value

IReadOnlyDictionary<string, object>

Status

public ProtoReportStatus Status { get; init; }

Property Value

ProtoReportStatus

Tags

public IReadOnlyList<string>? Tags { get; init; }

Property Value

IReadOnlyList<string>

TargetName

public string TargetName { get; init; }

Property Value

string

Unit

public string? Unit { get; init; }

Property Value

string

Value

public double? Value { get; init; }

Property Value

double?