str

Documentation

Overview

Package str are print to terminal display and colour functions.

Index

• func Piped() bool
• func Progress(name string, count, total int) float64
• func Sec(s string) string
• func Truncate(text string, length int) string
• func Warn(s string) string
• func X() string
• func Y() string

Functions

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(name string, count, total int) float64

Progress returns the count of total remaining as a percentage.

func Sec

func Sec(s string) string

Sec prints a secondary notice.

func Truncate

func Truncate(text string, length int) string

Truncate shortens a string to length characters.

func Warn

func Warn(s string) string

Warn prints a warning notice.

func X

func X() string

X returns a red ✗ cross mark.

func Y

func Y() string

Y returns a green ✓ tick mark.