Class ProtoResource

Namespace

ProtoTest.Core

Assembly

ProtoTest.Core.dll

A resource described by a release callback, for cases that do not warrant a type of their own.

public sealed class ProtoResource : IProtoResource

Inheritance

object

ProtoResource

Implements

IProtoResource

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, JsonSerializerOptions?)

Constructors

ProtoResource(string, string, string, Func<ProtoResourceReleaseContext, ValueTask>, ProtoResourceScope)

public ProtoResource(string id, string kind, string description, Func<ProtoResourceReleaseContext, ValueTask> release, ProtoResourceScope scope = ProtoResourceScope.Test)

Parameters

id string

kind string

description string

release Func<ProtoResourceReleaseContext, ValueTask>

scope ProtoResourceScope

Properties

Description

Gets a single line describing the resource for the trace, report and viewer.

public string Description { get; }

Property Value

string

Id

Gets the stable identity of the resource, for example customer:42.

public string Id { get; }

Property Value

string

Kind

Gets the resource kind, for example database or entity.

public string Kind { get; }

Property Value

string

Scope

Gets how long the resource lives. Defaults to the test that registered it.

public ProtoResourceScope Scope { get; }

Property Value

ProtoResourceScope

Methods

From(string, string, string, Func<ProtoResourceReleaseContext, CancellationToken, ValueTask>)

Creates a resource with an asynchronous release callback.

public static ProtoResource From(string id, string kind, string description, Func<ProtoResourceReleaseContext, CancellationToken, ValueTask> release)

Parameters

id string

kind string

description string

release Func<ProtoResourceReleaseContext, CancellationToken, ValueTask>

Returns

ProtoResource

ReleaseAsync(ProtoResourceReleaseContext)

Releases the resource. Each resource is released at most once, so implementations do not have to guard against repeated calls, but must tolerate a failed release being reported.

public ValueTask ReleaseAsync(ProtoResourceReleaseContext context)

Parameters

context ProtoResourceReleaseContext

Returns

ValueTask