utils

Documentation

Index

• Constants
• func CompVersion(v1, v2 string) (int, error)
• func Crypto(v []byte, key []byte) ([]byte, error)
• func CryptoToBase64(v []byte, key []byte) (string, error)
• func Decrypto(v []byte, key []byte) ([]byte, error)
• func DecryptoFromBase64(v string, key []byte) ([]byte, error)
• func Exists(name string) bool
• func ForceColor() bool
• func GenCryptoKey(base string) []byte
• func GenCryptoKeyWithBytes(base []byte) []byte
• func GetEnvFiles(root string) ([]string, error)
• func GetPageAndMax(ctx *gin.Context) (page int, max int, err error)
• func GetPageItems[T any](items []T, page, pageSize int) []T
• func GetPageItemsRange(total, page, pageSize int) (start, end int)
• func GetUrlExtension(u string) string
• func HttpCookieToMap(c []*http.Cookie) map[string]string
• func In[T comparable](items []T, item T) bool
• func Index[T comparable](items []T, item T) int
• func IsLocalIP(address string) bool
• func LIKE(s string) string
• func MapToHttpCookie(m map[string]string) []*http.Cookie
• func NoRedirectHttpClient() *http.Client
• func OptFilePath(filePath string) (string, error)
• func ParseURLIsLocalIP(u string) (bool, error)
• func RandBytes(n int) []byte
• func RandString(n int) string
• func ReadYaml(file string, module any) error
• func SortUUID() string
• func SortUUIDWithUUID(src uuid.UUID) string
• func SplitVersion(v string) ([]int, error)
• func TruncateByRune(s string, length int) string
• func WriteYaml(file string, module any) error
• type Once
  • func (o *Once) Do(f func())
  • func (o *Once) Done() (doned bool)
  • func (o *Once) Reset()
• type UpgraderConf
  • func WithSubprotocols(Subprotocols []string) UpgraderConf
• type WebSocket
  • func DefaultWebSocket() *WebSocket
  • func NewWebSocketServer(conf ...WebSocketConfig) *WebSocket
  • func (ws *WebSocket) NewWebSocketClient(w http.ResponseWriter, r *http.Request, responseHeader http.Header, ...) (*websocket.Conn, error)
  • func (ws *WebSocket) Server(w http.ResponseWriter, r *http.Request, Subprotocols []string, ...) error
• type WebSocketConfig
  • func WithHeartbeatInterval(d time.Duration) WebSocketConfig

Constants

const (
	VersionEqual = iota
	VersionGreater
	VersionLess
)

const (
	UA = `` /* 135-byte string literal not displayed */
)

Functions

func CompVersion

func CompVersion(v1, v2 string) (int, error)

func Crypto

func Crypto(v []byte, key []byte) ([]byte, error)

func CryptoToBase64

func CryptoToBase64(v []byte, key []byte) (string, error)

func Decrypto

func Decrypto(v []byte, key []byte) ([]byte, error)

func DecryptoFromBase64

func DecryptoFromBase64(v string, key []byte) ([]byte, error)

func Exists

func Exists(name string) bool

func ForceColor

func ForceColor() bool

func GenCryptoKey

func GenCryptoKey(base string) []byte

func GenCryptoKeyWithBytes

func GenCryptoKeyWithBytes(base []byte) []byte

func GetEnvFiles

func GetEnvFiles(root string) ([]string, error)

func GetPageAndMax

func GetPageAndMax(ctx *gin.Context) (page int, max int, err error)

func GetPageItems

func GetPageItems[T any](items []T, page, pageSize int) []T

func GetPageItemsRange

func GetPageItemsRange(total, page, pageSize int) (start, end int)

func GetUrlExtension

func GetUrlExtension(u string) string

func HttpCookieToMap

func HttpCookieToMap(c []*http.Cookie) map[string]string

func In

func In[T comparable](items []T, item T) bool

func Index

func Index[T comparable](items []T, item T) int

func IsLocalIP

func IsLocalIP(address string) bool

func LIKE

func LIKE(s string) string

func MapToHttpCookie

func MapToHttpCookie(m map[string]string) []*http.Cookie

func NoRedirectHttpClient

func NoRedirectHttpClient() *http.Client

func OptFilePath

func OptFilePath(filePath string) (string, error)

func ParseURLIsLocalIP

func ParseURLIsLocalIP(u string) (bool, error)

func RandBytes

func RandBytes(n int) []byte

func RandString

func RandString(n int) string

func ReadYaml

func ReadYaml(file string, module any) error

func SortUUID

func SortUUID() string

func SortUUIDWithUUID

func SortUUIDWithUUID(src uuid.UUID) string

func SplitVersion

func SplitVersion(v string) ([]int, error)

func TruncateByRune

func TruncateByRune(s string, length int) string

func WriteYaml

func WriteYaml(file string, module any) error

Types

type Once

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

func (*Once) Do

func (o *Once) Do(f func())

func (*Once) Done

func (o *Once) Done() (doned bool)

func (*Once) Reset

func (o *Once) Reset()

type UpgraderConf

type UpgraderConf func(*websocket.Upgrader)

func WithSubprotocols

func WithSubprotocols(Subprotocols []string) UpgraderConf

type WebSocket

type WebSocket struct {
	Heartbeat time.Duration
}

func DefaultWebSocket

func DefaultWebSocket() *WebSocket

func NewWebSocketServer

func NewWebSocketServer(conf ...WebSocketConfig) *WebSocket

func (*WebSocket) NewWebSocketClient

func (ws *WebSocket) NewWebSocketClient(w http.ResponseWriter, r *http.Request, responseHeader http.Header, conf ...UpgraderConf) (*websocket.Conn, error)

func (*WebSocket) Server

func (ws *WebSocket) Server(w http.ResponseWriter, r *http.Request, Subprotocols []string, handler func(c *websocket.Conn) error) error

type WebSocketConfig

type WebSocketConfig func(*WebSocket)

func WithHeartbeatInterval

func WithHeartbeatInterval(d time.Duration) WebSocketConfig