Strings

Documentation

Index

• func AndString(vals ...string) string
• func ArrayFormatter(values []string) string
• func DateStringer(date time.Time) string
• func FixTabStop(init, tabSize int, spacing, str string) (string, int)
• func LongestLine[T any](table [][]T) int
• func OrString(vals ...string) string
• func StringsJoiner[T fmt.Stringer](values []T, sep string) string
• func TabAlign(table [][]string, column int, tabSize int) ([][]string, error)
• func TableEntriesAlign(table [][]string, tabSize int) ([][]string, error)
• func TimeStringer(time time.Time) string
• type TableAligner
  • func NewTableAligner() *TableAligner
  • func (ta *TableAligner) AddRow(elems ...string)
  • func (ta *TableAligner) AlignColumn(idx int)
  • func (ta *TableAligner) Build(tabSize int, tableIndent bool) ([]string, error)
  • func (ta *TableAligner) Reset()
  • func (ta *TableAligner) SetHead(head string)

Functions

func AndString

func AndString(vals ...string) string

AndString concatenates a list of strings using commas and the word "and" before the last string.

Parameters:

• vals: The list of strings to concatenate.

Returns:

• string: The concatenated string.

func ArrayFormatter

func ArrayFormatter(values []string) string

ArrayFormatter formats a list of strings as an array.

Parameters:

• values: The list of strings to format.

Returns:

• string: The formatted array.

func DateStringer

func DateStringer(date time.Time) string

DateStringer prints the date in the format "1st January, 2006".

Parameters:

• date: The date to print.

Returns:

• string: The date in the format "1st January, 2006".

func FixTabStop

func FixTabStop(init, tabSize int, spacing, str string) (string, int)

FixTabStop fixes the tab stops in a string.

The initial level and the integer return are used for chaining multiple calls to this function.

Parameters:

• init: The initial level of the tab stop.
• tabSize: The size of the tab.
• spacing: The spacing to use for the tab stop.
• str: The string to fix the tab stops for.

Returns:

• string: The string with the tab stops fixed.
• int: The total number of characters in the string.

Behaviors:

• If the tabSize is less than 1, it is set to 1.
• If the initial tab stop is less than 0, it is set to 0.
• If the string is empty, an empty string is returned.

func LongestLine

func LongestLine[T any](table [][]T) int

LongestLine finds the longest line in a table.

Parameters:

• table: The table to find the longest line in.

Returns:

• int: The length of the longest line. -1 if the table is empty.

func OrString

func OrString(vals ...string) string

OrString concatenates a list of strings using commas and the word "or" before the last string.

Parameters:

• vals: The list of strings to concatenate.

Returns:

• string: The concatenated string.

func StringsJoiner

func StringsJoiner[T fmt.Stringer](values []T, sep string) string

StringsJoiner joins a list of fmt.Stringer values using a separator.

Parameters:

• values: The list of fmt.Stringer values to join.
• sep: The separator to use when joining the strings.

Returns:

• string: The string representation of the values.

func TabAlign

func TabAlign(table [][]string, column int, tabSize int) ([][]string, error)

TabAlign aligns the tabs of a table's column.

Parameters:

• table: The table to align.
• column: The column to align.
• tabSize: The size of the tab.

Returns:

• [][]string: The aligned table.
• error: An error of type *errors.ErrInvalidParameter if the tabSize is less than 1 or the column is less than 0.

Behaviors:

• If the column is not found in the table, the table is returned as is.

func TableEntriesAlign

func TableEntriesAlign(table [][]string, tabSize int) ([][]string, error)

TableEntriesAlign aligns the entries of a table.

Parameters:

• table: The table to align.
• tabSize: The size of the tab.

Returns:

• [][]string: The aligned table.
• error: An error if there was an issue aligning the table.

Errors:

• *errors.ErrAt: If there was an issue aligning a specific column.
• *errors.ErrInvalidParameter: If the tabSize is less than 1.

func TimeStringer

func TimeStringer(time time.Time) string

TimeStringer prints the time in the format "3:04 PM".

Parameters:

• time: The time to print.

Returns:

• string: The time in the format "3:04 PM".

Types

type TableAligner

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

TableAligner is a struct to help align tables.

func NewTableAligner

func NewTableAligner() *TableAligner

NewTableAligner creates a new table aligner.

func (*TableAligner) AddRow

func (ta *TableAligner) AddRow(elems ...string)

AddRow adds a row to the table.

Parameters:

• elems: The elements of the row.

func (*TableAligner) AlignColumn

func (ta *TableAligner) AlignColumn(idx int)

AlignColumn specifies a row to align.

Parameters:

• idx: The index of the row to align.

Behaviors:

• If the index is less than 0, the function does nothing.

func (*TableAligner) Build

func (ta *TableAligner) Build(tabSize int, tableIndent bool) ([]string, error)

Accept accepts the table aligner.

Parameters:

• tabSize: The size of the tab.
• tableIndent: Whether to indent the table.

Returns:

• error: An error of type *errors.ErrInvalidParameter if the tabSize is less than 1.

func (*TableAligner) Reset

func (ta *TableAligner) Reset()

Reset resets the table aligner for reuse.

func (*TableAligner) SetHead

func (ta *TableAligner) SetHead(head string)

SetHead sets the head of the table.

Parameters:

• head: The head of the table.