Documentation
¶
Overview ¶
Package text provides utilities for text formatting, humanization, and manipulation.
The package offers functions to format bytes and numbers into human-readable strings, handle durations, safely read from io.Reader, and indent text output. It includes utilities commonly needed for CLI tools and logging.
Key features:
- Human-readable byte formatting (e.g., "10M", "12.5K")
- Human-readable number formatting with metric suffixes
- Duration parsing and formatting
- Text indentation utilities
- Safe reader utilities
Byte formatting example:
size := int64(1536) fmt.Println(text.HumanizeBytes(size)) // "1.5K" size = 1073741824 fmt.Println(text.HumanizeBytes(size)) // "1G"
Number formatting example:
count := 1500 fmt.Println(text.HumanizeInt(count)) // "1.5k" count = 2000000 fmt.Println(text.HumanizeInt(count)) // "2m"
Duration example:
d := 3*time.Hour + 30*time.Minute fmt.Println(text.HumanizeDuration(d)) // "3h30m" age := text.Age(time.Now().Add(-24 * time.Hour)) fmt.Println(age) // "1d"
Indentation example:
indented := text.String(" ", "line1\nline2\nline3")
// Result:
// line1
// line2
// line3
Index ¶
- Constants
- func Age(d time.Time) string
- func Bytes(indent, b []byte) []byte
- func HumanizeBytes(size interface{}) string
- func HumanizeDuration(d time.Duration) string
- func HumanizeInt(size interface{}) string
- func NewWriter(w io.Writer, indent string) io.Writer
- func ParseDuration(val string) (*time.Duration, error)
- func SafeRead(r io.Reader) string
- func String(indent, s string) string
Constants ¶
const ( BYTE = 1 << (10 * iota) KILOBYTE MEGABYTE GIGABYTE TERABYTE PETABYTE EXABYTE )
const ( KILO = 1000 MEGA = 1000 * KILO GIGA = 1000 * MEGA )
Variables ¶
This section is empty.
Functions ¶
func Age ¶ added in v1.5.10
Age returns a human-readable string representing the time elapsed since the given time. It's a convenience function that combines time.Since with HumanizeDuration.
Example:
created := time.Now().Add(-24 * time.Hour)
fmt.Printf("Created %s ago", text.Age(created)) // "Created 1d ago"
func HumanizeBytes ¶ added in v1.5.2
func HumanizeBytes(size interface{}) string
HumanizeBytes returns a human-readable byte string of the form 10M, 12.5K, and so forth. The following units are available:
E: Exabyte (1024^6 bytes) P: Petabyte (1024^5 bytes) T: Terabyte (1024^4 bytes) G: Gigabyte (1024^3 bytes) M: Megabyte (1024^2 bytes) K: Kilobyte (1024 bytes) B: Byte
The unit that results in the smallest number greater than or equal to 1 is always chosen. The function accepts uint, uint64, int, int64, or string as input.
Examples:
HumanizeBytes(1024) // "1K"
HumanizeBytes(1536) // "1.5K"
HumanizeBytes(1048576) // "1M"
HumanizeBytes("1073741824") // "1G"
func HumanizeDuration ¶ added in v1.5.2
HumanizeDuration returns a string representing of a duration in the form "3d1h3m".
Leading zero units are omitted. As a special case, durations less than one second format use a smaller unit (milli-, micro-, or nanoseconds) to ensure that the leading digit is non-zero. Duration more than a day or more than a week lose granularity and are truncated to resp. days-hours-minutes and weeks-days-hours. The zero duration formats as 0s.
Examples:
HumanizeDuration(3*time.Hour + 30*time.Minute) // "3h30m" HumanizeDuration(24*time.Hour) // "1d" HumanizeDuration(168*time.Hour + 12*time.Hour) // "1w12h"
func HumanizeInt ¶ added in v1.29.1
func HumanizeInt(size interface{}) string
HumanizeInt formats integers with metric suffixes for readability. It uses decimal (base-10) units: k for thousands, m for millions, b for billions.
The function accepts uint, uint64, int, int64, or string as input.
Examples:
HumanizeInt(1500) // "1.5k"
HumanizeInt(2000000) // "2m"
HumanizeInt(1500000000) // "1.5b"
HumanizeInt("1000") // "1k"
func NewWriter ¶ added in v1.30.5
NewWriter returns an io.Writer that prefixes the lines written to it with indent and then writes them to w. The writer returns the number of bytes written to the underlying Writer.
func ParseDuration ¶ added in v1.5.10
ParseDuration parses a duration string with support for extended units like days and weeks. Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h", "d", "w", "y".
Examples:
d, _ := ParseDuration("3d12h") // 3 days 12 hours
d, _ := ParseDuration("1w") // 1 week
d, _ := ParseDuration("2h30m") // 2 hours 30 minutes
func SafeRead ¶
SafeRead reads all data from an io.Reader and returns it as a string. If an error occurs during reading, it returns an empty string instead of propagating the error. This is useful when you want to ensure a read operation never fails, such as in logging or display contexts.
Example:
resp, _ := http.Get("https://example.com")
defer resp.Body.Close()
content := text.SafeRead(resp.Body)
// content will be empty string if read fails
Types ¶
This section is empty.
Source Files