rstrings

Documentation

Overview

Package rstrings contains string and file-based operations, such as reading a file into a string

Index

• func CsvToMap(fname string) (result map[string][]string, err error)
• func DefaultIfEmpty(s, deflt string) string
• func EnsurePrefix(input string, prefix string) string
• func EnsureSuffix(input string, suffix string) string
• func EnsureWrapped(input string, wrapper string) string
• func FileToString(fname string) (result string, err error)
• func IsEmpty(s string) bool
• func IsNumeric(input string) bool
• func LeftPad(input string, length int) string
• func LeftPadWith(input string, char rune, length int) string
• func MapToString(input map[string]interface{}, isPretty ...bool) string
• func ReadStdInOrArgs() (string, error)
• func RightPad(input string, length int) string
• func RightPadWith(input string, char rune, length int) string
• type OnlyWhitespace
  • func (o OnlyWhitespace) Error() string

Functions

func CsvToMap

func CsvToMap(fname string) (result map[string][]string, err error)

CsvToMap takes the given filename, reads the file in CSV format, and returns a 2d map first dimension is the column name, second dimension is the row values for that column. input CSV file is expected to have a header row.

func DefaultIfEmpty

func DefaultIfEmpty(s, deflt string) string

DefaultIfEmpty returns the given string. If the given string is empty (see rstrings.IsEmpty), the given default is returned

func EnsurePrefix

func EnsurePrefix(input string, prefix string) string

EnsurePrefix prefixes the given string with the given prefix if it doesn't have it already examples: EnsurePrefix("foo", "f") = "foo" EnsurePrefix("foo", "new-") = "new-foo"

func EnsureSuffix

func EnsureSuffix(input string, suffix string) string

EnsureSuffix suffixes the given string with the given suffix if it doesn't have it already examples: EnsureSuffix("foo", "o") = "foo" EnsureSuffix("foo", "-new") = "foo-new"

func EnsureWrapped

func EnsureWrapped(input string, wrapper string) string

EnsureWrapped wraps the given string with the given prefix/suffix if it doesn't have it already examples: EnsureWrapped("foo", "'") = "'foo'" EnsureSuffix("fluff", "f") = "fluff"

func FileToString

func FileToString(fname string) (result string, err error)

FileToString reads from the given filename and returns the contents as a string

func IsEmpty

func IsEmpty(s string) bool

IsEmpty returns whether the given string has a length of 0 or is only whitespace examples: IsEmpty("") = true IsEmpty(" ") = True IsEmpty("b") = false IsEmpty(" b") = false IsEmpty("b ") = false IsEmpty(" b ") = false

func IsNumeric

func IsNumeric(input string) bool

IsNumeric returns whether the given string is numeric (only contains digits) an empty string is considered non-numeric

func LeftPad

func LeftPad(input string, length int) string

LeftPad prepend-pads the given string to the desired length with space characters. See LeftPadWith for implementation details

func LeftPadWith

func LeftPadWith(input string, char rune, length int) string

LeftPadWith prepend-pads the given string to the given length with the given rune. If the input string is already longer than the desired length, it is returned and NOT truncated

func MapToString

func MapToString(input map[string]interface{}, isPretty ...bool) string

MapToString converts the given map to a string. The variadic bool is a flag indicating whether the result should be prettified with newlines and whitespace default is false, for compatibility

func ReadStdInOrArgs

func ReadStdInOrArgs() (string, error)

ReadStdInOrArgs is a forgiving function for receiving user input for CLI applications. It attempts to read from std input (e.g. `ls | myCoolProgram`). If this fails, it takes the `os.arguments`, and joins them with a whitespace. If the resulting string is only whitespace (e.g. `echo " " | myCoolProgram`), then the original string is returned alongside an error of type OnlyWhitespace.

func RightPad

func RightPad(input string, length int) string

RightPad append-pads the given string to the desired length with space characters. See RightPadWith for implementation details

func RightPadWith

func RightPadWith(input string, char rune, length int) string

RightPadWith append-pads the given string to the given length with the given rune. If the input string is already longer than the desired length, it is returned and NOT truncated

Types

type OnlyWhitespace

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

func (OnlyWhitespace) Error

func (o OnlyWhitespace) Error() string