str

Documentation

Overview

Package str has string and stdout functions.

Index

• Constants
• func GetTerminalWidth() (int, error)
• func Month(month string) int
• func PathTitle(name string) string
• func Piped() bool
• func Progress(w io.Writer, name string, count, total int) float64
• func RemoveLine() string
• func TimeTaken(w io.Writer, elapsed float64)
• func Total(w io.Writer, count int, name string)
• func Truncate(text string, length int) string
• func X() string
• func Y() string
• func YearAbbr(s string) int

Constants

const (
	NothingToDo = "  OK, nothing to do" // NothingToDo is the message when there is nothing to do.
	PrePad      = "\t  "                // PrePad is the prefix padding for stdout.
)

Functions

func GetTerminalWidth

func GetTerminalWidth() (int, error)

func Month

func Month(month string) int

func PathTitle

func PathTitle(name string) string

PathTitle returns the title of the release extracted from the named directory path of the release. This is intended as a fallback when a file_id.diz cannot be parsed.

func Piped

func Piped() bool

Piped detects whether the program text is being piped to another operating system command or sent to stdout.

func Progress

func Progress(w io.Writer, name string, count, total int) float64

Progress returns the count of total remaining as a percentage.

func RemoveLine

func RemoveLine() string

func TimeTaken

func TimeTaken(w io.Writer, elapsed float64)

TimeTaken returns the elapsed time in seconds.

func Total

func Total(w io.Writer, count int, name string)

Total returns the count and name of the total number of items.

func Truncate

func Truncate(text string, length int) string

Truncate shortens a string to length characters.

func X

func X() string

X returns a red ✗ cross mark.

func Y

func Y() string

Y returns a green ✓ tick mark.

func YearAbbr

func YearAbbr(s string) int