PeanutButter
Loading...
Searching...
No Matches
PeanutButter.Utils.ConsoleSteps Class Reference

Provides factory methods for basic console steps. More...

Static Public Member Functions

static ITextStatusSteps Basic ()
 Creates the most basic steps:
static ITextStatusSteps Basic (string prefix)
 Creates the most basic steps:
static ITextStatusSteps Basic (string prefix, string startLabel, string okLabel, string failLabel, TextWriter target)
 Creates the most basic steps, using the provided labels and writer.
static ITextStatusSteps Basic (TextWriter writer)
 Creates the most basic steps:
static ITextStatusSteps Basic (string prefix, TextWriter writer)
 Creates the most basic steps, writing to the provided writer:
static ITextStatusSteps ForTesting ()
 Creates the most basic steps for test output:
static ITextStatusSteps ForTesting (string prefix)
 Creates the most basic steps for test output:
static ITextStatusSteps ForTesting (string prefix, string startLabel, string okLabel, string failLabel, TextWriter target)
 Creates the most basic steps, using the provided labels and writer.
static ITextStatusSteps ForTesting (TextWriter writer)
 Creates the most basic steps:
static ITextStatusSteps ForTesting (string prefix, TextWriter writer)
 Creates the most basic steps, writing to the provided writer:

Detailed Description

Provides factory methods for basic console steps.

Member Function Documentation

◆ Basic() [1/5]

ITextStatusSteps PeanutButter.Utils.ConsoleSteps.Basic ( )
static

Creates the most basic steps:

  • no color
  • ascii only
  • success marked with [ OK ]
  • failure marked with [FAIL]
Returns

◆ Basic() [2/5]

ITextStatusSteps PeanutButter.Utils.ConsoleSteps.Basic ( string prefix)
static

Creates the most basic steps:

  • no color
  • ascii only
  • success marked with [ OK ]
  • failure marked with [FAIL]
Returns

◆ Basic() [3/5]

ITextStatusSteps PeanutButter.Utils.ConsoleSteps.Basic ( string prefix,
string startLabel,
string okLabel,
string failLabel,
TextWriter target )
static

Creates the most basic steps, using the provided labels and writer.

  • no color
  • ascii only
Returns

◆ Basic() [4/5]

ITextStatusSteps PeanutButter.Utils.ConsoleSteps.Basic ( string prefix,
TextWriter writer )
static

Creates the most basic steps, writing to the provided writer:

  • no color
  • ascii only
  • success marked with [ OK ]
  • failure marked with [FAIL]
Returns

◆ Basic() [5/5]

ITextStatusSteps PeanutButter.Utils.ConsoleSteps.Basic ( TextWriter writer)
static

Creates the most basic steps:

  • no color
  • ascii only
  • success marked with [ OK ]
  • failure marked with [FAIL]
Returns

◆ ForTesting() [1/5]

ITextStatusSteps PeanutButter.Utils.ConsoleSteps.ForTesting ( )
static

Creates the most basic steps for test output:

  • no color
  • ascii only
  • success marked with [ OK ]
  • failure marked with [FAIL]
  • no line re-writing (each status on a new line)
  • errors are surfaced
Returns

◆ ForTesting() [2/5]

ITextStatusSteps PeanutButter.Utils.ConsoleSteps.ForTesting ( string prefix)
static

Creates the most basic steps for test output:

  • no color
  • ascii only
  • success marked with [ OK ]
  • failure marked with [FAIL]
  • no line re-writing (each status on a new line)
  • errors are surfaced
Returns

◆ ForTesting() [3/5]

ITextStatusSteps PeanutButter.Utils.ConsoleSteps.ForTesting ( string prefix,
string startLabel,
string okLabel,
string failLabel,
TextWriter target )
static

Creates the most basic steps, using the provided labels and writer.

  • no color
  • ascii only
  • no line re-writing (each status on a new line)
  • errors are surfaced
Returns

◆ ForTesting() [4/5]

ITextStatusSteps PeanutButter.Utils.ConsoleSteps.ForTesting ( string prefix,
TextWriter writer )
static

Creates the most basic steps, writing to the provided writer:

  • no color
  • ascii only
  • success marked with [ OK ]
  • failure marked with [FAIL]
  • no line re-writing (each status on a new line)
  • errors are surfaced
Returns

◆ ForTesting() [5/5]

ITextStatusSteps PeanutButter.Utils.ConsoleSteps.ForTesting ( TextWriter writer)
static

Creates the most basic steps:

  • no color
  • ascii only
  • success marked with [ OK ]
  • failure marked with [FAIL]
  • no line re-writing (each status on a new line)
  • errors are surfaced
Returns
The documentation for this class was generated from the following file:
  • source/Utils/PeanutButter.Utils/ConsoleSteps.cs