#cp.spec.DefaultHandler

Default implementation of Handler, which outputs via the standard print function.


#API Overview

Methods - API calls which can only be made on an object returned by a constructor


#API Documentation

#Methods

Signaturecp.spec.DefaultHandler:aborted(run, msg)
TypeMethod
DescriptionPrints an "[ABORT]" message.
Parameters
  • run - the run
  • msg - the message string.
Returns
  • None
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/spec/DefaultHandler.lua line 110

Signaturecp.spec.DefaultHandler:failed(run, msg) -> none
TypeMethod
DescriptionPrints a "[FAIL]" message.
Parameters
  • run - the run
  • msg - the message string.
Returns
  • None
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/spec/DefaultHandler.lua line 96

Signaturecp.spec.DefaultHandler:filter(run, msg) -> none
TypeMethod
DescriptionPrints a "[FILTER]" message.
Parameters
  • run - the run
  • msg - the message string.
Returns
  • None
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/spec/DefaultHandler.lua line 141

Signaturecp.spec.DefaultHandler:printf(test, ...)
TypeMethod
DescriptionPrints a spacer (if not the first line), followed by the text, optionally formatted with the provided parameters.
Parameters
  • text - The message to print.
  • ... - The parameters to interpolate into the text message.
Returns
  • None
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/spec/DefaultHandler.lua line 38

Signaturecp.spec.DefaultHandler:printSpacer()
TypeMethod
DescriptionPrints a blank line if this is not the first time it has been called.
Parameters
  • None
Returns
  • None
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/spec/DefaultHandler.lua line 22

Signaturecp.spec.DefaultHandler:start(run, msg)
TypeMethod
DescriptionIf the handler or run is verbose, prints a "[PASS]" message.
Parameters
  • run - the run
  • msg - the message string.
Returns
  • None
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/spec/DefaultHandler.lua line 79

Signaturecp.spec.DefaultHandler:stop(run)
TypeMethod
DescriptionIf the handler or run is verbose, prints a "[STOP]" message.
Parameters
Returns
  • None
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/spec/DefaultHandler.lua line 66

Signaturecp.spec.DefaultHandler:summary(run, report) -> none
TypeMethod
DescriptionIf the handler or run is verbose, prints a "[RESULT]" message.
Parameters
Returns
  • None
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/spec/DefaultHandler.lua line 155

Signaturecp.spec.DefaultHandler:waiting(run, timeout) -> none
TypeMethod
DescriptionPrints a "[WAIT]" message with the timeout value..
Parameters
  • run - run
  • timeout - timeout
Returns
  • None
NotesNone
ExamplesNone
Sourcesrc/extensions/cp/spec/DefaultHandler.lua line 124