utils

Documentation

Index

• Variables
• func ClientIP(r *http.Request) string
• func CopyDir(src, dst string) error
• func CopyFile(src, dst string) error
• func CopyWithCtx(ctx context.Context, out io.Writer, in io.Reader, size int64, ...) error
• func CreateNestedDirectory(path string) error
• func CreateNestedFile(path string) (*os.File, error)
• func CreateTempFile(r io.ReadCloser) (*os.File, error)
• func EncodePath(path string, all ...bool) string
• func Exists(name string) bool
• func Ext(path string) string
• func FixAndCleanPath(path string) string
• func GetActualMountPath(mountPath string) string
• func GetFileType(filename string) int
• func GetFullPath(mountPath, path string) string
• func GetMD5Encode(data []byte) string
• func GetMD5EncodeStr(data string) string
• func GetMimeType(name string) string
• func GetObjType(filename string, isDir bool) int
• func GetSHA1Encode(data []byte) string
• func GetSHA256Encode(data []byte) string
• func InjectQuery(raw string, query url.Values) (string, error)
• func IsBalance(str string) bool
• func IsBool(bs ...bool) bool
• func IsCanceled(ctx context.Context) bool
• func IsEmailFormat(email string) bool
• func IsLocalIP(ip net.IP) bool
• func IsLocalIPAddr(ip string) bool
• func IsSubPath(path string, subPath string) bool
• func JoinBasePath(basePath, reqPath string) (string, error)
• func LimitRateReflect(f interface{}, interval time.Duration) func(...interface{}) []interface{}
• func LimitWriter(w io.Writer, size int64) io.Writer
• func MappingName(name string) string
• func MergeErrors(errs ...error) error
• func MergeMap(mObj ...map[string]interface{}) map[string]interface{}
• func MustParseCNTime(str string) time.Time
• func MustSliceConvert[S any, D any](srcS []S, convert func(src S) D) []D
• func NewDebounce(interval time.Duration) func(f func())
• func NewDebounce2(interval time.Duration, f func()) func()
• func NewLimitReadCloser(reader io.Reader, close CloseFunc, limit int64) io.ReadCloser
• func NewReadCloser(reader io.Reader, close CloseFunc) io.ReadCloser
• func PathAddSeparatorSuffix(path string) string
• func PathEqual(path1, path2 string) bool
• func SafeAtob(data string) (string, error)
• func SliceContains[T comparable](arr []T, v T) bool
• func SliceConvert[S any, D any](srcS []S, convert func(src S) (D, error)) ([]D, error)
• func SliceEqual[T comparable](a, b []T) bool
• func SliceMeet[T1, T2 any](arr []T1, v T2, meet func(item T1, v T2) bool) bool
• func SymlinkOrCopyFile(src, dst string) error
• func WriteJsonToFile(dst string, data interface{}, std ...bool) bool
• type CloseFunc
  • func (c CloseFunc) Close() error
• type Fn
  • func LimitRate[T any, R any](f Fn[T, R], interval time.Duration) Fn[T, R]
• type FnCtx
  • func LimitRateCtx[T any, R any](f FnCtx[T, R], interval time.Duration) FnCtx[T, R]
• type MultiReadable
  • func NewMultiReadable(reader io.Reader) *MultiReadable
  • func (mr *MultiReadable) Close() error
  • func (mr *MultiReadable) Read(p []byte) (int, error)
  • func (mr *MultiReadable) Reset() error
• type ReadCloser

Variables

var DEC = map[string]string{
	"-": "+",
	"_": "/",
	".": "=",
}

var Json = json.ConfigCompatibleWithStandardLibrary

var Log = log.New()

Functions

func ClientIP

func ClientIP(r *http.Request) string

func CopyDir

func CopyDir(src, dst string) error

CopyDir Dir copies a whole directory recursively

func CopyFile

func CopyFile(src, dst string) error

CopyFile File copies a single file from src to dst

func CopyWithCtx

func CopyWithCtx(ctx context.Context, out io.Writer, in io.Reader, size int64, progress func(percentage int)) error

CopyWithCtx slightly modified function signature: - context has been added in order to propagate cancelation - I do not return the number of bytes written, has it is not useful in my use case

func CreateNestedDirectory

func CreateNestedDirectory(path string) error

CreateNestedDirectory create nested directory

func CreateNestedFile

func CreateNestedFile(path string) (*os.File, error)

CreateNestedFile create nested file

func CreateTempFile

func CreateTempFile(r io.ReadCloser) (*os.File, error)

CreateTempFile create temp file from io.ReadCloser, and seek to 0

func EncodePath

func EncodePath(path string, all ...bool) string

func Exists

func Exists(name string) bool

Exists determine whether the file exists

func Ext

func Ext(path string) string

func FixAndCleanPath

func FixAndCleanPath(path string) string

FixAndCleanPath The upper layer of the root directory is still the root directory. So ".." And "." will be cleared for example 1. ".." or "." => "/" 2. "../..." or "./..." => "/..." 3. "../.x." or "./.x." => "/.x." 4. "x//\\y" = > "/z/x"

func GetActualMountPath

func GetActualMountPath(mountPath string) string

GetActualMountPath remove balance suffix

func GetFileType

func GetFileType(filename string) int

GetFileType get file type

func GetFullPath

func GetFullPath(mountPath, path string) string

func GetMD5Encode

func GetMD5Encode(data []byte) string

func GetMD5EncodeStr

func GetMD5EncodeStr(data string) string

func GetMimeType

func GetMimeType(name string) string

func GetObjType

func GetObjType(filename string, isDir bool) int

func GetSHA1Encode

func GetSHA1Encode(data []byte) string

func GetSHA256Encode

func GetSHA256Encode(data []byte) string

func InjectQuery

func InjectQuery(raw string, query url.Values) (string, error)

func IsBalance

func IsBalance(str string) bool

func IsBool

func IsBool(bs ...bool) bool

func IsCanceled

func IsCanceled(ctx context.Context) bool

func IsEmailFormat

func IsEmailFormat(email string) bool

func IsLocalIP

func IsLocalIP(ip net.IP) bool

func IsLocalIPAddr

func IsLocalIPAddr(ip string) bool

func IsSubPath

func IsSubPath(path string, subPath string) bool

func JoinBasePath

func JoinBasePath(basePath, reqPath string) (string, error)

func LimitRateReflect

func LimitRateReflect(f interface{}, interval time.Duration) func(...interface{}) []interface{}

func LimitWriter

func LimitWriter(w io.Writer, size int64) io.Writer

func MappingName

func MappingName(name string) string

func MergeErrors

func MergeErrors(errs ...error) error

func MergeMap

func MergeMap(mObj ...map[string]interface{}) map[string]interface{}

func MustParseCNTime

func MustParseCNTime(str string) time.Time

func MustSliceConvert

func MustSliceConvert[S any, D any](srcS []S, convert func(src S) D) []D

func NewDebounce

func NewDebounce(interval time.Duration) func(f func())

func NewDebounce2

func NewDebounce2(interval time.Duration, f func()) func()

func NewLimitReadCloser

func NewLimitReadCloser(reader io.Reader, close CloseFunc, limit int64) io.ReadCloser

func NewReadCloser

func NewReadCloser(reader io.Reader, close CloseFunc) io.ReadCloser

func PathAddSeparatorSuffix

func PathAddSeparatorSuffix(path string) string

PathAddSeparatorSuffix Add path '/' suffix for example /root => /root/

func PathEqual

func PathEqual(path1, path2 string) bool

PathEqual judge path is equal

func SafeAtob

func SafeAtob(data string) (string, error)

func SliceContains

func SliceContains[T comparable](arr []T, v T) bool

SliceContains check if slice contains element

func SliceConvert

func SliceConvert[S any, D any](srcS []S, convert func(src S) (D, error)) ([]D, error)

SliceConvert convert slice to another type slice

func SliceEqual

func SliceEqual[T comparable](a, b []T) bool

SliceEqual check if two slices are equal

func SliceMeet

func SliceMeet[T1, T2 any](arr []T1, v T2, meet func(item T1, v T2) bool) bool

func SymlinkOrCopyFile

func SymlinkOrCopyFile(src, dst string) error

SymlinkOrCopyFile symlinks a file or copy if symlink failed

func WriteJsonToFile

func WriteJsonToFile(dst string, data interface{}, std ...bool) bool

WriteJsonToFile write struct to json file

Types

type CloseFunc

type CloseFunc func() error

func (CloseFunc) Close

func (c CloseFunc) Close() error

type Fn

type Fn[T any, R any] func(T) (R, error)

func LimitRate

func LimitRate[T any, R any](f Fn[T, R], interval time.Duration) Fn[T, R]

type FnCtx

type FnCtx[T any, R any] func(context.Context, T) (R, error)

func LimitRateCtx

func LimitRateCtx[T any, R any](f FnCtx[T, R], interval time.Duration) FnCtx[T, R]

type MultiReadable

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

func NewMultiReadable

func NewMultiReadable(reader io.Reader) *MultiReadable

func (*MultiReadable) Close

func (mr *MultiReadable) Close() error

func (*MultiReadable) Read

func (mr *MultiReadable) Read(p []byte) (int, error)

func (*MultiReadable) Reset

func (mr *MultiReadable) Reset() error

type ReadCloser

type ReadCloser struct {
	io.Reader
	io.Closer
}