util

Documentation

Index

• Constants
• func CopyDir(srcPath, destPath string) error
• func CopyFile(src, dest string) error
• func EnsureAbsolutePath(path string, absoluteBase string) string
• func ExistsInSlice(target string, slice []string) bool
• func FileURLToPath(u *url.URL) (string, error)
• func GetDirectorySize(path string) (int64, error)
• func IsDir(dir string) (bool, error)
• func IsEmptyString(s string) bool
• func IsEqualSlice(target []string, source []string) bool
• func IsExist(path string) (bool, error)
• func IsFile(filePath string) (bool, error)
• func IsIPPrivate(ip net.IP) bool
• func IsInt64InSlice(target int64, slice []int64) bool
• func IsSliceInt64Eq(a, b []int64) bool
• func IsStringInSlice(target string, slice []string, insensitive ...bool) bool
• func Max(a, b int) int
• func MergeInto(dict map[string]interface{}, values ...interface{}) (map[string]interface{}, error)
• func Min(a, b int) int
• func NewSanitizedError(err error, oldnew ...string) error
• func NewStringURLSanitizedError(err error, unsanitizedURL string, usePlaceholder bool) error
• func NewStringURLSanitizer(unsanitizedURL string, usePlaceholder bool) *strings.Replacer
• func NewURLSanitizedError(err error, u *url.URL, usePlaceholder bool) error
• func NewURLSanitizer(u *url.URL, usePlaceholder bool) *strings.Replacer
• func NormalizeEOL(input []byte) []byte
• func PaginateSlice(list interface{}, page, pageSize int) interface{}
• func PathEscapeSegments(path string) string
• func RandomInt(limit int64) (int64, error)
• func RandomString(length int64) (string, error)
• func ReadAtMost(r io.Reader, buf []byte) (n int, err error)
• func Remove(name string) error
• func RemoveAll(name string) error
• func Rename(oldpath, newpath string) error
• func ShellEscape(toEscape string) string
• func SplitStringAtByteN(input string, n int) (left, right string)
• func StatDir(rootPath string, includeDir ...bool) ([]string, error)
• func StopTimer(t *time.Timer) bool
• func URLJoin(base string, elems ...string) string
• type Int64Slice
  • func (p Int64Slice) Len() int
  • func (p Int64Slice) Less(i, j int) bool
  • func (p Int64Slice) Swap(i, j int)
• type OptionalBool
  • func OptionalBoolOf(b bool) OptionalBool
  • func (o OptionalBool) IsFalse() bool
  • func (o OptionalBool) IsNone() bool
  • func (o OptionalBool) IsTrue() bool

Constants

const (
	// OptionalBoolNone a "null" boolean value
	OptionalBoolNone = iota
	// OptionalBoolTrue a "true" boolean value
	OptionalBoolTrue
	// OptionalBoolFalse a "false" boolean value
	OptionalBoolFalse
)

Functions

func CopyDir

func CopyDir(srcPath, destPath string) error

CopyDir copy files recursively from source to target directory. It returns error when error occurs in underlying functions.

func CopyFile

func CopyFile(src, dest string) error

CopyFile copies file from source to target path.

func EnsureAbsolutePath

func EnsureAbsolutePath(path string, absoluteBase string) string

EnsureAbsolutePath ensure that a path is absolute, making it relative to absoluteBase if necessary

func ExistsInSlice

func ExistsInSlice(target string, slice []string) bool

ExistsInSlice returns true if string exists in slice.

func FileURLToPath

func FileURLToPath(u *url.URL) (string, error)

FileURLToPath extracts the path information from a file://... url.

func GetDirectorySize

func GetDirectorySize(path string) (int64, error)

GetDirectorySize returns the dumb disk consumption for a given path

func IsDir

func IsDir(dir string) (bool, error)

IsDir returns true if given path is a directory, or returns false when it's a file or does not exist.

func IsEmptyString

func IsEmptyString(s string) bool

IsEmptyString checks if the provided string is empty

func IsEqualSlice

func IsEqualSlice(target []string, source []string) bool

IsEqualSlice returns true if slices are equal.

func IsExist

func IsExist(path string) (bool, error)

IsExist checks whether a file or directory exists. It returns false when the file or directory does not exist.

func IsFile

func IsFile(filePath string) (bool, error)

IsFile returns true if given path is a file, or returns false when it's a directory or does not exist.

func IsIPPrivate

func IsIPPrivate(ip net.IP) bool

IsIPPrivate for net.IP.IsPrivate. TODO: replace with `ip.IsPrivate()` if min go version is bumped to 1.17

func IsInt64InSlice

func IsInt64InSlice(target int64, slice []int64) bool

IsInt64InSlice sequential searches if int64 exists in slice.

func IsSliceInt64Eq

func IsSliceInt64Eq(a, b []int64) bool

IsSliceInt64Eq returns if the two slice has the same elements but different sequences.

func IsStringInSlice

func IsStringInSlice(target string, slice []string, insensitive ...bool) bool

IsStringInSlice sequential searches if string exists in slice.

func Max

func Max(a, b int) int

Max max of two ints

func MergeInto

func MergeInto(dict map[string]interface{}, values ...interface{}) (map[string]interface{}, error)

MergeInto merges pairs of values into a "dict"

func Min

func Min(a, b int) int

Min min of two ints

func NewSanitizedError

func NewSanitizedError(err error, oldnew ...string) error

NewSanitizedError wraps an error and replaces all old, new string pairs in the message text.

func NewStringURLSanitizedError

func NewStringURLSanitizedError(err error, unsanitizedURL string, usePlaceholder bool) error

NewStringURLSanitizedError wraps an error and replaces the url credential or removes them. If the url can't get parsed it gets replaced with a placeholder string.

func NewStringURLSanitizer

func NewStringURLSanitizer(unsanitizedURL string, usePlaceholder bool) *strings.Replacer

NewStringURLSanitizer creates a replacer for the url with the credential sanitized or removed. If the url can't get parsed it gets replaced with a placeholder string

func NewURLSanitizedError

func NewURLSanitizedError(err error, u *url.URL, usePlaceholder bool) error

NewURLSanitizedError wraps an error and replaces the url credential or removes them.

func NewURLSanitizer

func NewURLSanitizer(u *url.URL, usePlaceholder bool) *strings.Replacer

NewURLSanitizer creates a replacer for the url with the credential sanitized or removed.

func NormalizeEOL

func NormalizeEOL(input []byte) []byte

NormalizeEOL will convert Windows (CRLF) and Mac (CR) EOLs to UNIX (LF)

func PaginateSlice

func PaginateSlice(list interface{}, page, pageSize int) interface{}

PaginateSlice cut a slice as per pagination options if page = 0 it do not paginate

func PathEscapeSegments

func PathEscapeSegments(path string) string

PathEscapeSegments escapes segments of a path while not escaping forward slash

func RandomInt

func RandomInt(limit int64) (int64, error)

RandomInt returns a random integer between 0 and limit, inclusive

func RandomString

func RandomString(length int64) (string, error)

RandomString generates a random alphanumerical string

func ReadAtMost

func ReadAtMost(r io.Reader, buf []byte) (n int, err error)

ReadAtMost reads at most len(buf) bytes from r into buf. It returns the number of bytes copied. n is only less then len(buf) if r provides fewer bytes. If EOF occurs while reading, err will be nil.

func Remove

func Remove(name string) error

Remove removes the named file or (empty) directory with at most 5 attempts.

func RemoveAll

func RemoveAll(name string) error

RemoveAll removes the named file or (empty) directory with at most 5 attempts.

func Rename

func Rename(oldpath, newpath string) error

Rename renames (moves) oldpath to newpath with at most 5 attempts.

func ShellEscape

func ShellEscape(toEscape string) string

ShellEscape will escape the provided string. We can't just use go-shellquote here because our preferences for escaping differ from those in that we want:

* If the string doesn't require any escaping just leave it as it is. * If the string requires any escaping prefer double quote escaping * If we have ! or newlines then we need to use single quote escaping

func SplitStringAtByteN

func SplitStringAtByteN(input string, n int) (left, right string)

SplitStringAtByteN splits a string at byte n accounting for rune boundaries. (Combining characters are not accounted for.)

func StatDir

func StatDir(rootPath string, includeDir ...bool) ([]string, error)

StatDir gathers information of given directory by depth-first. It returns slice of file list and includes subdirectories if enabled; it returns error and nil slice when error occurs in underlying functions, or given path is not a directory or does not exist.

Slice does not include given path itself. If subdirectories is enabled, they will have suffix '/'.

func StopTimer

func StopTimer(t *time.Timer) bool

StopTimer is a utility function to safely stop a time.Timer and clean its channel

func URLJoin

func URLJoin(base string, elems ...string) string

URLJoin joins url components, like path.Join, but preserving contents

Types

type Int64Slice

type Int64Slice []int64

Int64Slice attaches the methods of Interface to []int64, sorting in increasing order.

func (Int64Slice) Len

func (p Int64Slice) Len() int

func (Int64Slice) Less

func (p Int64Slice) Less(i, j int) bool

func (Int64Slice) Swap

func (p Int64Slice) Swap(i, j int)

type OptionalBool

type OptionalBool byte

OptionalBool a boolean that can be "null"

func OptionalBoolOf

func OptionalBoolOf(b bool) OptionalBool

OptionalBoolOf get the corresponding OptionalBool of a bool

func (OptionalBool) IsFalse

func (o OptionalBool) IsFalse() bool

IsFalse return true if equal to OptionalBoolFalse

func (OptionalBool) IsNone

func (o OptionalBool) IsNone() bool

IsNone return true if equal to OptionalBoolNone

func (OptionalBool) IsTrue

func (o OptionalBool) IsTrue() bool

IsTrue return true if equal to OptionalBoolTrue