strings

Documentation

Index

• func ClipLeft(s string, maxLength int) string
• func ClipRight(s string, maxLength int) string
• func MaxInt(a int, b int) int
• func MinInt(a int, b int) int
• func PrettyPrintMap[K comparable, V any](m map[K]V) string
• type SortBy
• type SortMode
• type StrOrder
  • func (strOrder StrOrder) Index(s string) int
• type Table
  • func NewTable(header ...string) *Table
  • func (t *Table) NumRows() int
  • func (t Table) Sort() *Table
  • func (t Table) SortBy(sortBy []SortBy) *Table
  • func (t Table) String() string
  • func (t *Table) TotalsByCol(col int) map[string]int
  • func (t Table) WithFooter(item string) *Table
  • func (t Table) WithHeader(items ...string) *Table
  • func (t Table) WithRow(row ...string) *Table

Functions

func ClipLeft

func ClipLeft(s string, maxLength int) string

func ClipRight

func ClipRight(s string, maxLength int) string

func MaxInt

func MaxInt(a int, b int) int

func MinInt

func MinInt(a int, b int) int

func PrettyPrintMap

func PrettyPrintMap[K comparable, V any](m map[K]V) string

Single line map string format from "map[foo:90 bar:30]" to "(foo: 90, bar: 30)"

Types

type SortBy

type SortBy struct {
	Name   string
	Number int
	Mode   SortMode
	Order  StrOrder
}

type SortMode

type SortMode int

SortMode defines How to sort.

const (
	// Asc sorts the column in Ascending order alphabetically.
	Asc SortMode = iota
	// AscNumeric sorts the column in Ascending order numerically.
	AscNumeric
	// Custom sorts the column in Ascending order by custom string index order
	AscCustom
	// Dsc sorts the column in Descending order alphabetically.
	Dsc
	// DscNumeric sorts the column in Descending order numerically.
	DscNumeric
	// Custom sorts the column in Descending order by custom string index order
	DscCustom
)

type StrOrder

type StrOrder []string

StrOrder defines a custom index to sort by. Ex: StrOrder{"Hot", "Warm", "Cold"}

func (StrOrder) Index

func (strOrder StrOrder) Index(s string) int

Finds the index of a string in an array

type Table

type Table struct {
	// contains filtered or unexported fields
}

func NewTable

func NewTable(header ...string) *Table

func (*Table) NumRows

func (t *Table) NumRows() int

func (Table) Sort

func (t Table) Sort() *Table

func (Table) SortBy

func (t Table) SortBy(sortBy []SortBy) *Table

SortBy sets the rules for sorting the Rows in the order specified. i.e., the first SortBy instruction takes precedence over the second and so on. Any duplicate instructions on the same column will be discarded while sorting.

func (Table) String

func (t Table) String() string

func (*Table) TotalsByCol

func (t *Table) TotalsByCol(col int) map[string]int

func (Table) WithFooter

func (t Table) WithFooter(item string) *Table

func (Table) WithHeader

func (t Table) WithHeader(items ...string) *Table

func (Table) WithRow

func (t Table) WithRow(row ...string) *Table