util

Documentation

Overview

Package util provides generally helpful functions used by the ipgs system

Index

• func FatalIfErr(note string, err error)
• func GetBoolForPrompt(prompt string, def bool) (bool, error)
• func GetIntForPrompt(prompt string, def int) (int, error)
• func GetStringForPrompt(prompt, def string) (string, error)

Functions

func FatalIfErr

func FatalIfErr(note string, err error)

FatalIfErr uses log.Fatalln to halt execution if err is not nil with the message "failed to [note]: [err]"

func GetBoolForPrompt

func GetBoolForPrompt(prompt string, def bool) (bool, error)

GetBoolForPrompt writes a prompt to STDOUT and expects a "y" or a "n" in response. Returns true if "y" was entered, otherwise returns false.

func GetIntForPrompt

func GetIntForPrompt(prompt string, def int) (int, error)

GetIntForPromt writes a prompt to STDOUT and expects an integer in response. Returns the input converted to an integer if possible, or an error if not.

func GetStringForPrompt

func GetStringForPrompt(prompt, def string) (string, error)

GetStringForPrompt writes a prompt to STDOUT and returns the string entered into STDIN. If the user does not enter anything, the default string is returned.