util

Documentation

Index

• Variables
• func Capitalize(s string) string
• func CleanRelativePath(path string) (string, error)
• func DecodeBasicAuthHeader(header string) (string, string, error)
• func DecodeQuotedPrintable(encodedValue string) string
• func Decrypt(payload []byte, secret string) ([]byte, error)
• func EncodePassword(password string, salt string) (string, error)
• func Encrypt(payload []byte, secret string) ([]byte, error)
• func GenerateShortUID() string
• func GetAgeString(t time.Time) string
• func GetBasicAuthHeader(user string, password string) string
• func GetRandomString(n int, alphabets ...byte) (string, error)
• func IsEmail(str string) bool
• func IsShortUIDTooLong(uid string) bool
• func IsValidShortUID(uid string) bool
• func JoinURLFragments(a, b string) string
• func Md5Sum(reader io.Reader) (string, error)
• func Md5SumString(input string) (string, error)
• func MinInt(x, y int) int
• func RandomHex(n int) (string, error)
• func SplitEmails(emails string) []string
• func SplitString(str string) []string
• func StringsFallback2(val1 string, val2 string) string
• func StringsFallback3(val1 string, val2 string, val3 string) string
• func ToCamelCase(str string) string
• func Walk(path string, followSymlinks bool, detectSymlinkInfiniteLoop bool, ...) error
• type DynMap
• type NetworkAddress
  • func SplitHostPortDefault(input, defaultHost, defaultPort string) (NetworkAddress, error)
• type URLQueryReader
  • func NewURLQueryReader(urlInfo *url.URL) (*URLQueryReader, error)
  • func (r *URLQueryReader) Get(name string, def string) string
• type WalkFunc

Variables

var ErrWalkSkipDir = errors.New("skip this directory")

ErrWalkSkipDir is the Error returned when we want to skip descending into a directory

Functions

func Capitalize

func Capitalize(s string) string

func CleanRelativePath

func CleanRelativePath(path string) (string, error)

CleanRelativePath returns the shortest path name equivalent to path by purely lexical processing. It make sure the provided path is rooted and then uses filepath.Clean and filepath.Rel to make sure the path doesn't include any separators or elements that shouldn't be there like ., .., //.

func DecodeBasicAuthHeader

func DecodeBasicAuthHeader(header string) (string, string, error)

DecodeBasicAuthHeader decodes user and password from a basic auth header.

func DecodeQuotedPrintable

func DecodeQuotedPrintable(encodedValue string) string

decodeQuotedPrintable decodes quoted-printable UTF-8 string

func Decrypt

func Decrypt(payload []byte, secret string) ([]byte, error)

Decrypt decrypts a payload with a given secret. DEPRECATED. Do not use it. Use secrets.Service instead.

func EncodePassword

func EncodePassword(password string, salt string) (string, error)

EncodePassword encodes a password using PBKDF2.

func Encrypt

func Encrypt(payload []byte, secret string) ([]byte, error)

Encrypt encrypts a payload with a given secret. DEPRECATED. Do not use it. Use secrets.Service instead.

func GenerateShortUID

func GenerateShortUID() string

GenerateShortUID generates a short unique identifier.

func GetAgeString

func GetAgeString(t time.Time) string

GetAgeString returns a string representing certain time from years to minutes.

func GetBasicAuthHeader

func GetBasicAuthHeader(user string, password string) string

GetBasicAuthHeader returns a base64 encoded string from user and password.

func GetRandomString

func GetRandomString(n int, alphabets ...byte) (string, error)

GetRandomString generate random string by specify chars. source: https://github.com/gogits/gogs/blob/9ee80e3e5426821f03a4e99fad34418f5c736413/modules/base/tool.go#L58

func IsEmail

func IsEmail(str string) bool

IsEmail checks if a string is a valid email address.

func IsShortUIDTooLong

func IsShortUIDTooLong(uid string) bool

IsShortUIDTooLong checks if short unique identifier is too long

func IsValidShortUID

func IsValidShortUID(uid string) bool

IsValidShortUID checks if short unique identifier contains valid characters

func JoinURLFragments

func JoinURLFragments(a, b string) string

JoinURLFragments joins two ApiURL fragments into only one ApiURL string.

func Md5Sum

func Md5Sum(reader io.Reader) (string, error)

Md5Sum calculates the md5sum of a stream

func Md5SumString

func Md5SumString(input string) (string, error)

Md5SumString calculates the md5sum of a string

func MinInt

func MinInt(x, y int) int

MinInt returns the smaller of x or y.

func RandomHex

func RandomHex(n int) (string, error)

RandomHex returns a random string from a n seed.

func SplitEmails

func SplitEmails(emails string) []string

SplitEmails splits addresses with a few different ways

func SplitString

func SplitString(str string) []string

SplitString splits a string by commas or empty spaces.

func StringsFallback2

func StringsFallback2(val1 string, val2 string) string

StringsFallback2 returns the first of two not empty strings.

func StringsFallback3

func StringsFallback3(val1 string, val2 string, val3 string) string

StringsFallback3 returns the first of three not empty strings.

func ToCamelCase

func ToCamelCase(str string) string

ToCamelCase changes kebab case, snake case or mixed strings to camel case. See unit test for examples.

func Walk

func Walk(path string, followSymlinks bool, detectSymlinkInfiniteLoop bool, walkFn WalkFunc) error

Walk walks a path, optionally following symbolic links, and for each path, it calls the walkFn passed.

It is similar to filepath.Walk, except that it supports symbolic links and can detect infinite loops while following sym links. It solves the issue where your WalkFunc needs a path relative to the symbolic link (resolving links within walkfunc loses the path to the symbolic link for each traversal).

Types

type DynMap

type DynMap map[string]interface{}

DynMap defines a dynamic map interface.

type NetworkAddress

type NetworkAddress struct {
	Host string
	Port string
}

func SplitHostPortDefault

func SplitHostPortDefault(input, defaultHost, defaultPort string) (NetworkAddress, error)

SplitHostPortDefault splits ip address/hostname string by host and port. Defaults used if no match found

type URLQueryReader

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

URLQueryReader is a ApiURL query type.

func NewURLQueryReader

func NewURLQueryReader(urlInfo *url.URL) (*URLQueryReader, error)

NewURLQueryReader parses a raw query and returns it as a URLQueryReader type.

func (*URLQueryReader) Get

func (r *URLQueryReader) Get(name string, def string) string

Get parse parameters from an ApiURL. If the parameter does not exist, it returns the default value.

type WalkFunc

type WalkFunc func(resolvedPath string, info os.FileInfo, err error) error

WalkFunc is a callback function called for each path as a directory is walked If resolvedPath != "", then we are following symbolic links.