Class

RunUpdate

ConsoleMonster.Live

Edit on GitHub

Namespace: ConsoleMonster.Live
Assembly: ConsoleMonster
Source: WidgetUpdate.cs:175
Modifiers: sealed

An update to one item of a caller-managed run.

Inheritance

object
RunUpdate

Usage

Explore 21 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by 10

Extension method RunUpdate.Detail
Extension method RunUpdate.Duration
Extension method RunUpdate.Index
Extension method RunUpdate.Label
Extension method RunUpdate.Status
Method RunUpdateFluent.Detail
Method RunUpdateFluent.Duration
Method RunUpdateFluent.Index
Method RunUpdateFluent.Label
Method RunUpdateFluent.Status

Accepted by parameters 11

Method ConsoleUpdate.Apply parameter update
Extension method RunUpdate.Detail parameter runUpdate
Extension method RunUpdate.Duration parameter runUpdate
Extension method RunUpdate.Index parameter runUpdate
Extension method RunUpdate.Label parameter runUpdate
Extension method RunUpdate.Status parameter runUpdate
Method RunUpdateFluent.Detail parameter runUpdate
Method RunUpdateFluent.Duration parameter runUpdate
Method RunUpdateFluent.Index parameter runUpdate
Method RunUpdateFluent.Label parameter runUpdate
Method RunUpdateFluent.Status parameter runUpdate

Constructors

public RunUpdate() #

Inherited Methods

Properties

public int Index { get; set; } #

WidgetUpdate.cs:175

The zero-based item position.

public StatusKind Status { get; set; } #

WidgetUpdate.cs:177

Running, Pass, Fail, Warn or Skip.

public string? Label { get; set; } #

WidgetUpdate.cs:179

The current phase label.

public string? Detail { get; set; } #

WidgetUpdate.cs:181

The completion detail.

public TimeSpan? Duration { get; set; } #

WidgetUpdate.cs:183

An optional measured duration.

Extension Methods

public static RunUpdate Detail(RunUpdate runUpdate, string? value) #

Sets RunUpdate.Detail: The completion detail.

Parameters

runUpdate ConsoleMonster.Live.RunUpdate required: The instance.
value string? required: The value.

Returns

RunUpdate The same instance.

Examples

// C# initializer or property                                    // C# fluent
new global::ConsoleMonster.Live.RunUpdate { Detail = value };    runUpdate.Detail(value);

public static RunUpdate Duration(RunUpdate runUpdate, TimeSpan? value) #

Sets RunUpdate.Duration: An optional measured duration.

Parameters

runUpdate ConsoleMonster.Live.RunUpdate required: The instance.
value System.TimeSpan? required: The value.

Returns

RunUpdate The same instance.

Examples

// C# initializer or property                                      // C# fluent
new global::ConsoleMonster.Live.RunUpdate { Duration = value };    runUpdate.Duration(value);

public static RunUpdate Index(RunUpdate runUpdate, int value) #

Sets RunUpdate.Index: The zero-based item position.

Parameters

runUpdate ConsoleMonster.Live.RunUpdate required: The instance.
value int required: The value.

Returns

RunUpdate The same instance.

Examples

// C# initializer or property                                   // C# fluent
new global::ConsoleMonster.Live.RunUpdate { Index = value };    runUpdate.Index(value);

public static RunUpdate Label(RunUpdate runUpdate, string? value) #

Sets RunUpdate.Label: The current phase label.

Parameters

runUpdate ConsoleMonster.Live.RunUpdate required: The instance.
value string? required: The value.

Returns

RunUpdate The same instance.

Examples

// C# initializer or property                                   // C# fluent
new global::ConsoleMonster.Live.RunUpdate { Label = value };    runUpdate.Label(value);

public static RunUpdate Status(RunUpdate runUpdate, StatusKind value) #

Sets RunUpdate.Status: Running, Pass, Fail, Warn or Skip.

Parameters

runUpdate ConsoleMonster.Live.RunUpdate required: The instance.
value ConsoleMonster.Styling.StatusKind required: The value.

Returns

RunUpdate The same instance.

Examples

// C# initializer or property                                    // C# fluent
new global::ConsoleMonster.Live.RunUpdate { Status = value };    runUpdate.Status(value);