util

Documentation

Overview

Package util provides simple utility functions usable in all modules.

Index

• func BeautifulName(uglyName string) string
• func CanonicalName(name string) string
• func DefaultString(s, d string) string
• func SanitizedName(unsafeName string) string
• func StringID(s string) string
• func TernaryConditionString(cond bool, thenBranch, elseBranch string) string
• func ValidURL(s string) bool

Functions

func BeautifulName

func BeautifulName(uglyName string) string

BeautifulName makes the ugly name beautiful by replacing _ with spaces and using title case

func CanonicalName

func CanonicalName(name string) string

CanonicalName returns the canonical form of the name. A name is canonical if it is lowercase, all left and right whitespace is trimmed and all spaces are replaced with underscores.

func DefaultString

func DefaultString(s, d string) string

DefaultString returns d if s is an empty string, s otherwise.

func SanitizedName

func SanitizedName(unsafeName string) string

SanitizedName is unsafeName with all unsafe characters removed.

func StringID

func StringID(s string) string

StringID sanitizes the string and makes it more suitable for the id attribute in HTML.

func TernaryConditionString

func TernaryConditionString(cond bool, thenBranch, elseBranch string) string

TernaryConditionString is an approximation of an expression like (cond ? thenBranch : elseBranch) from other programming languages. There is no real need for this function, I just felt the urge to add it.

func ValidURL

func ValidURL(s string) bool

ValidURL is true if s is a valid absolute URL.