PeanutButter
Loading...
Searching...
No Matches
PeanutButter.Utils.ITextStatusSteps Interface Reference

Describes the contract for textural feedback around running activities. More...

Inheritance diagram for PeanutButter.Utils.ITextStatusSteps:
PeanutButter.Utils.TextStatusSteps PeanutButter.Utils.SuppressedTextStatusSteps

Public Member Functions

void Run (string label, Action activity)
 Run the provided activity with the given label.
 
Task RunAsync (string label, Func< Task > activity)
 Run the provided async activity with the given label.
 
void Log (string str)
 Simply log within the context of the steps (ie with the same io & prefixing)
 
Task LogAsync (string str)
 Simply log within the context of the steps (ie with the same io & prefixing)
 

Detailed Description

Describes the contract for textural feedback around running activities.

Member Function Documentation

◆ Log()

void PeanutButter.Utils.ITextStatusSteps.Log ( string  str)

Simply log within the context of the steps (ie with the same io & prefixing)

Parameters
str

Implemented in PeanutButter.Utils.TextStatusSteps.

◆ LogAsync()

Task PeanutButter.Utils.ITextStatusSteps.LogAsync ( string  str)

Simply log within the context of the steps (ie with the same io & prefixing)

Parameters
str

Implemented in PeanutButter.Utils.TextStatusSteps.

◆ Run()

void PeanutButter.Utils.ITextStatusSteps.Run ( string  label,
Action  activity 
)

Run the provided activity with the given label.

Parameters
label
activity

Implemented in PeanutButter.Utils.TextStatusSteps.

◆ RunAsync()

Task PeanutButter.Utils.ITextStatusSteps.RunAsync ( string  label,
Func< Task >  activity 
)

Run the provided async activity with the given label.

Parameters
label
activity

Implemented in PeanutButter.Utils.TextStatusSteps.


The documentation for this interface was generated from the following file: