Documentation
¶
Index ¶
- Variables
- func FormatFailure(headline string, extraLines []string, err error) string
- func FormatInfo(headline string, extraLines []string) string
- func FormatSuccess(headline string, extraLines []string) string
- func FormatWarning(headline string, extraLines []string, err error) string
- func PrintCheckboxFailure(actionText string, err error)
- func PrintCheckboxPending(actionText string)
- func PrintCheckboxSkipped(actionText string)
- func PrintCheckboxSuccess(actionText string)
- func RunWithCheckboxes(checkboxMessage string, f func() error) error
Constants ¶
This section is empty.
Variables ¶
var SkipThisAction = fmt.Errorf("skip this action")
SkipThisAction can be called inside `RunWithCheckboxes` mark the given action as skipped.
Functions ¶
func FormatFailure ¶
FormatFailure prints a formatted failure message. It should be used for errors where the program is going to terminate.
func FormatInfo ¶
FormatInfo prints a formatted info message. It should be used for useful information that you want to draw to the readers attention
func FormatSuccess ¶
FormatSuccess prints a formatted info message. It should be used for a positive confirmation that something worked, with more information
func FormatWarning ¶
FormatWarning prints a formatted failure message. It should be used for errors where the program is going to continue.
func PrintCheckboxFailure ¶
func PrintCheckboxPending ¶
func PrintCheckboxPending(actionText string)
func PrintCheckboxSkipped ¶
func PrintCheckboxSkipped(actionText string)
func PrintCheckboxSuccess ¶
func PrintCheckboxSuccess(actionText string)
func RunWithCheckboxes ¶
RunWithCheckboxes executes the given function f and captures its return value, which must be error. Before running, it prints the "pending" checkbox, then if the function succeeds (error=nil), prints a success checkbox, otherwise prints a failed checkbox. example:
``` var apiResult response
if err := ui.RunWithCheckboxes("Uploading to API", func() error {
apiResult, err = api.Upload(...)
return err
})
```
Types ¶
This section is empty.
Source Files