Class ProtoTraceOperation

Namespace: ProtoTest.Core

Assembly: ProtoTest.Core.dll

A timed operation in a ProtoTest execution trace.

public sealed class ProtoTraceOperation : IDisposable

Inheritance: object

ProtoTraceOperation

Implements: IDisposable

Inherited Members: object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods: SheetModelAssertions.ShouldMatchShape<TRow>(TRow, object, bool, JsonSerializerOptions?)

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

Properties

Id

public string Id { get; }

Property Value

string

Methods

AddSection(ProtoTraceSection)

Adds a section to the operation: facts, a payload, check results or a diff. Sections are how an integration describes its operation; the viewer renders them without knowing the integration.

public ProtoTraceOperation AddSection(ProtoTraceSection section)

Parameters

section ProtoTraceSection

Returns

ProtoTraceOperation

Cancel(Exception?)

public void Cancel(Exception? exception = null)

Parameters

exception Exception

Complete(ProtoTraceOutcome, Exception?)

public void Complete(ProtoTraceOutcome outcome, Exception? exception = null)

Parameters

outcome ProtoTraceOutcome
exception Exception

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

public void Dispose()

Fail(Exception)

Fails the operation. An OperationCanceledException is part of the shared failure vocabulary, not a product failure: it completes the operation as Cancelled wherever the cancellation surfaces.

public void Fail(Exception exception)

Parameters

exception Exception

SetAttribute(string, string?)

public ProtoTraceOperation SetAttribute(string name, string? value)

Parameters

name string
value string

Returns

ProtoTraceOperation

Succeed()

public void Succeed()