str

package

v1.11.13 Latest Latest Go to latest Published: Mar 31, 2024 License: Apache-2.0 Imports: 12 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/Defacto2/df2

Links

Open Source Insights

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 ¶

View Source

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.
)

Variables ¶

This section is empty.

Functions ¶

func GetTerminalWidth ¶ added in v1.11.1

func GetTerminalWidth() (int, error)

func Month ¶ added in v1.11.1

func Month(month string) int

func PathTitle ¶ added in v1.11.1

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 ¶ added in v1.11.1

func RemoveLine() string

func TimeTaken ¶ added in v1.11.0

func TimeTaken(w io.Writer, elapsed float64)

TimeTaken returns the elapsed time in seconds.

func Total ¶ added in v1.11.3

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 ¶ added in v1.11.1

func YearAbbr(s string) int

Types ¶

This section is empty.

Source Files ¶

View all Source files

str.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL