gox

README

gox

Golang的基础库，提供各种便捷的方法，包括

• 字符串
• 配置
• 时间处理
• 基础类型

感谢Jetbrains

本项目通过Jetbrains开源许可IDE编写源代码，特此感谢

Documentation

Index

• Constants
• func Atoi(num string, base int) int64
• func Atoid(num string) int64
• func Contains[T any](items *[]T, item T) bool
• func ContentDisposition(filename string, dispositionType ContentDispositionType) (disposition string)
• func Flat[T flatType](from T) *flatConverter[T]
• func FormatInt(num int64, base int) string
• func FormatIntd(num int64) string
• func Gid() (id uint64)
• func If[T any](condition bool, result T) (t T)
• func Ifx[T any](condition bool, first T, second T) (t T)
• func Index[T any](items *[]T, item T) (index int)
• func Set[T any](setter func(value T), first T, second T)
• func Ternary[T any](condition bool, first T, second T) (t T)
• func ToString(from any) (to string)
• func ToStrings(from ...any) (to []string)
• type CannotCompare
• type CannotCopy
• type Case
  • func (c *Case) Camel(upperPos casePosition) *Case
  • func (c *Case) Lowercase(pos casePosition) *Case
  • func (c *Case) String() string
  • func (c *Case) Underscore(upperPos casePosition) *Case
• type ContentDispositionType
• type Field
• type Fields
  • func (f Fields[T]) Add(fields ...Field[T]) (new Fields[T])
  • func (f Fields[T]) String() string
• type HttpMethod
• type HttpParameterType
• type Key
• type Kv
• type Object
• type Package
  • func (p *Package) Name() (name string)
  • func (p *Package) String() string
• type Size
  • func ParseSize(from string) (size Size, err error)
  • func (s *Size) Bit() int64
  • func (s *Size) Bit32() int32
  • func (s *Size) Formatter() *sizeFormatter
  • func (s *Size) MarshalJSON() (bytes []byte, err error)
  • func (s *Size) String() string
  • func (s *Size) UnmarshalJSON(bytes []byte) (err error)
• type UriScheme
• type Value

Constants

const (
	// CasePositionNone 无
	CasePositionNone casePosition = iota
	// CasePositionHead 首
	CasePositionHead
	// CasePositionTail 尾
	CasePositionTail
	// CasePositionAll 全部
	CasePositionAll
)

const (
	// StringEmpty 空字符串
	StringEmpty = ""
	StringSpace = " "

	// Float64Size 64位长度
	Float64Size = 64
)

const (
	// HeaderAcceptLanguage 可接受的语言
	HeaderAcceptLanguage = "Accept-Language"
	// HeaderContentType 请求数据类型
	HeaderContentType = "Content-Type"
	// HeaderAuthorization 授权
	HeaderAuthorization = "Authorization"
	// HeaderContentDisposition 下载时的附件名指定
	HeaderContentDisposition = "Content-disposition"

	// HttpMethodGet GET方法
	HttpMethodGet HttpMethod = "GET"
	// HttpMethodPost POST方法
	HttpMethodPost HttpMethod = "POST"
	// HttpMethodPut PUT方法
	HttpMethodPut HttpMethod = "PUT"
	// HttpMethodDelete DELETE方法
	HttpMethodDelete HttpMethod = "DELETE"
	// HttpMethodPatch PATCH方法
	HttpMethodPatch HttpMethod = "PATCH"
	// HttpMethodHead HEAD方法
	HttpMethodHead HttpMethod = "HEAD"
	// HttpMethodOptions OPTIONS方法
	HttpMethodOptions HttpMethod = "OPTIONS"
)

const (
	SizeB  Size = 1
	SizeKB      = 1024 * SizeB
	SizeMB      = 1024 * SizeKB
	SizeGB      = 1024 * SizeMB
	SizeTB      = 1024 * SizeGB
	SizePB      = 1024 * SizeTB
	SizeEB      = 1024 * SizePB
)

Functions

func Atoi

func Atoi(num string, base int) int64

Atoi 增强版进制转换，支持任意进制，最大76进制

func Atoid

func Atoid(num string) int64

Atoid 进制转换，默认使用76进制

func Contains

func Contains[T any](items *[]T, item T) bool

Contains 判断元素是否在数组中

func ContentDisposition

func ContentDisposition(filename string, dispositionType ContentDispositionType) (disposition string)

ContentDisposition 解决附件下载乱码

func Flat

func Flat[T flatType](from T) *flatConverter[T]

func FormatInt

func FormatInt(num int64, base int) string

FormatInt 增强版进制转换，最大支持76进制

func FormatIntd

func FormatIntd(num int64) string

FormatIntd 进制转换，默认使用76进制

func Gid

func Gid() (id uint64)

Gid 当前协程编号

func If

func If[T any](condition bool, result T) (t T)

If 模块条件表达式，主要用法是减少大括号

func Ifx

func Ifx[T any](condition bool, first T, second T) (t T)

Ifx 模拟三元表达式，主要用法是减少大括号

func Index

func Index[T any](items *[]T, item T) (index int)

Index 在列表中找出元素的下标

func Set

func Set[T any](setter func(value T), first T, second T)

Set 设置方法，当`first`值为零值时，设置为`second`的值，否则设置`first`的值

func Ternary

func Ternary[T any](condition bool, first T, second T) (t T)

Ternary 模拟三元表达式，主要用法是减少大括号

func ToString

func ToString(from any) (to string)

ToString 将任意类型转换为字符串

func ToStrings

func ToStrings(from ...any) (to []string)

ToStrings 将任意类型转换成字符串列表

Types

type CannotCompare

type CannotCompare [0]func()

CannotCompare 不能比较

type CannotCopy

type CannotCopy [0]sync.Mutex

CannotCopy 不能复制

type Case

type Case string

Case 字符串转换

func (*Case) Camel

func (c *Case) Camel(upperPos casePosition) *Case

Camel 转为驼峰写法

func (*Case) Lowercase

func (c *Case) Lowercase(pos casePosition) *Case

Lowercase 首字母小写

func (*Case) String

func (c *Case) String() string

String 最终结果

func (*Case) Underscore

func (c *Case) Underscore(upperPos casePosition) *Case

Underscore 转为下划线写法

type ContentDispositionType

type ContentDispositionType string

ContentDispositionType 下载类型

const (
	// ContentDispositionTypeAttachment 附件下载
	ContentDispositionTypeAttachment ContentDispositionType = "attachment"
	// ContentDispositionTypeInline 浏览器直接打开
	ContentDispositionTypeInline ContentDispositionType = "inline"
)

type Field

type Field[T any] Kv[string, T]

Field 字段，一个键值对，要求键必须是字符串

type Fields

type Fields[T any] []Field[T]

Fields 字段列表

func (Fields[T]) Add

func (f Fields[T]) Add(fields ...Field[T]) (new Fields[T])

func (Fields[T]) String

func (f Fields[T]) String() string

type HttpMethod

type HttpMethod string

HttpMethod Http方法

type HttpParameterType

type HttpParameterType string

HttpParameterType Http额外参数类型

const (
	// HttpParameterTypeHeader 请求头
	HttpParameterTypeHeader HttpParameterType = "header"
	// HttpParameterTypePathParameter 路径参数
	HttpParameterTypePathParameter HttpParameterType = "path"
)

type Key

type Key[T any] interface {
	// Key 返回键值
	Key() T
}

Key 键

type Kv

type Kv[K any, V any] interface {
	Key[K]
	Value[V]
}

Kv 键值对

type Object

type Object struct{}

Object 基础对象

type Package

type Package string

Package 包名

func (*Package) Name

func (p *Package) Name() (name string)

func (*Package) String

func (p *Package) String() string

type Size

type Size int64

Size 字节大小

func ParseSize

func ParseSize(from string) (size Size, err error)

ParseSize 解析字节大小

func (*Size) Bit

func (s *Size) Bit() int64

func (*Size) Bit32

func (s *Size) Bit32() int32

func (*Size) Formatter

func (s *Size) Formatter() *sizeFormatter

func (*Size) MarshalJSON

func (s *Size) MarshalJSON() (bytes []byte, err error)

func (*Size) String

func (s *Size) String() string

func (*Size) UnmarshalJSON

func (s *Size) UnmarshalJSON(bytes []byte) (err error)

type UriScheme

type UriScheme string

UriScheme 协议

const (
	// UriSchemeUnknown 未知协议
	UriSchemeUnknown UriScheme = ``
	// UriSchemeSocksV4 Socks协议
	UriSchemeSocksV4 UriScheme = "socks4"
	// UriSchemeSocksV5 Socks协议
	UriSchemeSocksV5 UriScheme = "socks4"
	// UriSchemeHttp Http协议
	UriSchemeHttp UriScheme = "http"
	// UriSchemeHttps Https协议
	UriSchemeHttps UriScheme = "https"
	// UriSchemeRtmp Rtmp协议
	UriSchemeRtmp UriScheme = "rtmp"
	// UriSchemeMqtt MQTT协议
	UriSchemeMqtt UriScheme = "mqtt"
	// UriSchemeMqtts MQTT安全协议
	UriSchemeMqtts UriScheme = "mqtts"
	// UriSchemeWs Websocket协议
	UriSchemeWs UriScheme = "ws"
	// UriSchemeWss Websocket安全协议
	UriSchemeWss UriScheme = "wss"
)

type Value

type Value[T any] interface {
	// Value 返回具体的值
	Value() T
}

Value 值