Skip to content
ConsoleMonster

API Reference

Class

LanesHandle

Edit on GitHub
Namespace ConsoleMonster.Widgets
Assembly ConsoleMonster
Source LanesHandle.cs:10
Base LiveHandle
Modifiers sealed

Thread-safe live handle for a Lanes widget.

Inheritance

Usage

Explore 1 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 1

Constructors

public LanesHandle(ILiveDispatcher dispatcher, String target) #
LanesHandle.cs:10

Creates a handle.

Parameters

dispatcher ConsoleMonster.Live.ILiveDispatcher requiredposition: 0
The dispatcher.
target System.String requiredposition: 1
The lanes name.

Methods

public Void Add(String key, String? label = null, Double total = 0) #
LanesHandle.cs:17
Returns: Void

Adds a lane.

Parameters

key System.String requiredposition: 0
Unique key.
label System.String? = null optionalposition: 1
Label, or null for the key.
total System.Double = 0 optionalposition: 2
Planned steps.
public Void Advance(String key, StatusKind result = Pass, String? detail = null, Double steps = 1) #
LanesHandle.cs:29
Returns: Void

Records completed steps and their result.

Parameters

key System.String requiredposition: 0
The lane.
result ConsoleMonster.Styling.StatusKind = Pass optionalposition: 1
The step result (counted as passed, failed, warning or skipped).
detail System.String? = null optionalposition: 2
What the lane is doing next, or null.
steps System.Double = 1 optionalposition: 3
Steps completed (default 1).
public Void Complete(String key, StatusKind? status = null) #
LanesHandle.cs:39
Returns: Void

Finishes a lane; without a status it becomes Fail when any step failed, Warn when any warned, else Pass.

Parameters

key System.String requiredposition: 0
The lane.
status ConsoleMonster.Styling.StatusKind? = null optionalposition: 1
The final status, or null to derive it.
public Void Detail(String key, String detail) #
LanesHandle.cs:34
Returns: Void

Sets what the lane is doing now.

Parameters

key System.String requiredposition: 0
The lane.
detail System.String requiredposition: 1
The detail.
public Void Start(String key, String? detail = null) #
LanesHandle.cs:22
Returns: Void

Marks a lane as running.

Parameters

key System.String requiredposition: 0
The lane.
detail System.String? = null optionalposition: 1
What it is doing.