environment

Documentation

Index

• func Ask(prompt string) string
• func AskPassword(prompt string) string
• func Msg(label, message string, colour color.Attribute, wrapWidth int) string
• func PrintErrorMessage(label, message string)
• func PrintlnErrorMessage(label, message string)
• type CaptureError
  • func (e CaptureError) Error() string
• type CapturingPassThroughWriter
  • func NewCapturingPassThroughWriter(w io.Writer) *CapturingPassThroughWriter
  • func (w *CapturingPassThroughWriter) Bytes() []byte
  • func (w *CapturingPassThroughWriter) Write(d []byte) (int, error)
• type ConfigurationError
  • func (e ConfigurationError) Error() string
• type Manager
  • func NewManager(namespace string) Manager
  • func (c *Manager) ReadConfiguration(data interface{}) error

Functions

func Ask

func Ask(prompt string) string

Ask can be used to get some input from the user. The user input will not be hidden (not secure).

func AskPassword

func AskPassword(prompt string) string

AskPassword asks password from the user and hides the input.

func Msg

func Msg(label, message string, colour color.Attribute, wrapWidth int) string

Msg returns with a string to print to a nicely formatted output with progress.

func PrintErrorMessage

func PrintErrorMessage(label, message string)

PrintErrorMessage displays an error message using Msg without newline at the end.

func PrintlnErrorMessage

func PrintlnErrorMessage(label, message string)

PrintlnErrorMessage displays an error message using Msg with newline at the end.

Types

type CaptureError

type CaptureError struct {
	Message  string
	Original string
}

CaptureError occurs when something went wrong with capturing io.

func (CaptureError) Error

func (e CaptureError) Error() string

type CapturingPassThroughWriter

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

CapturingPassThroughWriter is a writer that remembers data written to it and passes it to w.

func NewCapturingPassThroughWriter

func NewCapturingPassThroughWriter(w io.Writer) *CapturingPassThroughWriter

NewCapturingPassThroughWriter creates new CapturingPassThroughWriter.

func (*CapturingPassThroughWriter) Bytes

func (w *CapturingPassThroughWriter) Bytes() []byte

Bytes returns bytes written to the writer.

func (*CapturingPassThroughWriter) Write

func (w *CapturingPassThroughWriter) Write(d []byte) (int, error)

type ConfigurationError

type ConfigurationError struct {
	Message  string
	Original string
}

ConfigurationError occurs when something went wrong reading the configuration file.

func (ConfigurationError) Error

func (e ConfigurationError) Error() string

type Manager

type Manager struct {
	Namespace string
}

Manager is a central manager, mostly for configuration files, later others like cache, persistent storage, etc.

func NewManager

func NewManager(namespace string) Manager

NewManager creates a new Manager.

func (*Manager) ReadConfiguration

func (c *Manager) ReadConfiguration(data interface{}) error

ReadConfiguration reads and parses the configuration file.