output

Documentation

Overview

Package output handles the output for Goophry. It provides routines to enable debug messages. Also output can be written to a logfile instead of printing it to stdout. Furthermore it provides the possibility to execute a command to notify an external script/application.

Index

• type Output
  • func NewOutput() Output
  • func (o Output) Debug(msg string)
  • func (o Output) NotifyError(msg string)
  • func (o *Output) SetDebug(d bool)
  • func (o *Output) SetLogfile(path string) error
  • func (o *Output) SetNotifyCmd(cmd string)
  • func (o Output) StopError(msg string)

Types

type Output

type Output struct {
	// contains filtered or unexported fields
}

An Output provides routines to handle messages within Goophry.

func NewOutput

func NewOutput() Output

NewOutput returns a new instance of Output, writing the messages to stdout per default.

func (Output) Debug

func (o Output) Debug(msg string)

Debug writes a message to the current output, when debugging output is enabled.

func (Output) NotifyError

func (o Output) NotifyError(msg string)

NotifyError executes the notify-command with a given message.

func (*Output) SetDebug

func (o *Output) SetDebug(d bool)

SetDebug enables/disables debugging output.

func (*Output) SetLogfile

func (o *Output) SetLogfile(path string) error

SetLogfile modifies the Output object to write messages to the given logfile instead of stdout. It may return an error, if something went wrong with opening the file.

func (*Output) SetNotifyCmd

func (o *Output) SetNotifyCmd(cmd string)

SetNotifyCmd sets the command used for notifying about certain messages.

func (Output) StopError

func (o Output) StopError(msg string)

StopError writes a message to the current output, executes the notify-command and exits Goophry with the status 1.