api

Documentation

Index

• Constants
• Variables
• func Bytes2String(b []byte) string
• func ChanIsClosed(ch any) bool
• func CheckFilepath(filename string, notExistToCreate ...bool) error
• func CloseQuietly(closer io.Closer)
• func Convert[T any](data []string, v *T) error
• func Copy[T any, S any](to *T, from *S) (err error)
• func CopyWithOption(toValue interface{}, fromValue interface{}, opt Option) (err error)
• func CsvToSlices[S ~[]E, E any](filename string, pointer *S) error
• func DateZero(t time.Time) time.Time
• func DifferDays(t1, t2 time.Time) int
• func EndsWith(str string, suffixes []string) bool
• func FileExist(path string) bool
• func FileIsValid(path string) bool
• func Filter[S ~[]E, E any](slice S, condition func(E) bool) S
• func Float64s(a *[]float64)
• func Float64sAreUnique(a []float64) bool
• func GetMonthDay() (string, string)
• func GetQuarterByDate(date string, diffQuarters ...int) (quarter, first, last string)
• func GetQuarterDay(months ...int) (string, string)
• func GetQuarterDayByDate(date string, diffQuarters ...int) (firstOfQuarter, lastOfQuarter string)
• func GetWeekDay() (string, string)
• func Ints(a *[]int)
• func IntsAreUnique(a []int) bool
• func IsEmpty(s string) bool
• func IsUniqued(data sort.Interface) bool
• func IsWorkday(t time.Time) bool
• func KebabCase(s string) string
• func LowerCamelCase(s string) string
• func ParseFloat(s string) float64
• func ParseInt(s string) int64
• func ParseTime(timestr string) (time.Time, error)
• func ParseUint(s string) uint64
• func Reverse[S ~[]E, E any](s S) S
• func SliceSort[S ~[]E, E any](slice S, less func(a, b E) bool)
• func SliceUnique[S ~[]E, E any](slicePtr *S, less func(i, j int) bool)
• func SlicesToCsv[S ~[]E, E any](filename string, s S) error
• func SnakeCase(s string) string
• func Sort(data Interface)
• func StartsWith(str string, prefixes []string) bool
• func String2Bytes(s string) []byte
• func Strings(a *[]string)
• func StringsAreUnique(a []string) bool
• func ToCamelCase(kebab string) (camelCase string)
• func ToFront(data sort.Interface) (n int)
• func ToString(value interface{}) string
• func Unique(data Interface)
• func UpperCamelCase(s string) string
• func UpperKebabCase(s string) string
• func UpperSnakeCase(s string) string
• type Float64Slice
  • func (p Float64Slice) Len() int
  • func (p Float64Slice) Less(i, j int) bool
  • func (p Float64Slice) Swap(i, j int)
  • func (p Float64Slice) Truncate(n int)
• type IntSlice
  • func (p IntSlice) Len() int
  • func (p IntSlice) Less(i, j int) bool
  • func (p IntSlice) Swap(i, j int)
  • func (p IntSlice) Truncate(n int)
• type Interface
• type Option
• type ScopeLimit
  • func IntsToRanges(ints []int) []ScopeLimit
  • func RangeFinite(start int, end ...int) ScopeLimit
  • func (r *ScopeLimit) Limits(length int) (s int, e int, _ error)
  • func (r *ScopeLimit) NRows(length ...int) (int, error)
  • func (r ScopeLimit) String() string
• type StringSlice
  • func (p StringSlice) Len() int
  • func (p StringSlice) Less(i, j int) bool
  • func (p StringSlice) Swap(i, j int)
  • func (p StringSlice) Truncate(n int)

Constants

const (
	// CACHE_DIR_MODE 目录权限
	CACHE_DIR_MODE os.FileMode = 0755
	// CACHE_FILE_MODE 文件权限
	CACHE_FILE_MODE os.FileMode = 0644

	// DEBUG 调试开关
	DEBUG = false
	// CACHE_REPLACE 文件替换模式, 会用到os.TRUNC
	CACHE_REPLACE = os.O_CREATE | os.O_RDWR | os.O_TRUNC
	// CACHE_UPDATE 更新
	CACHE_UPDATE = os.O_CREATE | os.O_WRONLY
)

const (
	DefaultTagName = "dataframe"
)

const (
	IGNORE_FLOAT = true
)

const (
	YearOnly = "2006" // 日期格式仅输出"年"
)

Variables

var (
	ErrInvalidCopyDestination = errors.New("copy destination is invalid")
	ErrInvalidCopyFrom        = errors.New("copy from is invalid")
	ErrMapKeyNotMatch         = errors.New("map's key type doesn't match")
	ErrNotSupported           = errors.New("not supported")
)

Functions

func Bytes2String

func Bytes2String(b []byte) string

Bytes2String 字节数组转字符串

func ChanIsClosed

func ChanIsClosed(ch any) bool

ChanIsClosed 判断channel是否关闭

func CheckFilepath

func CheckFilepath(filename string, notExistToCreate ...bool) error

CheckFilepath

检查filename 文件路径, 如果不存在就创建

func CloseQuietly

func CloseQuietly(closer io.Closer)

CloseQuietly 关闭io, 忽略错误

func Convert

func Convert[T any](data []string, v *T) error

Convert 将字符串数组按照下标的序号反射给一个结构体

func Copy

func Copy[T any, S any](to *T, from *S) (err error)

Copy copy things

func CopyWithOption

func CopyWithOption(toValue interface{}, fromValue interface{}, opt Option) (err error)

CopyWithOption copy with option

func CsvToSlices

func CsvToSlices[S ~[]E, E any](filename string, pointer *S) error

CsvToSlices CSV文件转struct切片

func DateZero

func DateZero(t time.Time) time.Time

DateZero t 的0点0分0秒

func DifferDays

func DifferDays(t1, t2 time.Time) int

DifferDays 计算天数差

从 t1 回到 t2 需要多少天

func EndsWith

func EndsWith(str string, suffixes []string) bool

EndsWith 字符串前缀判断

func FileExist

func FileExist(path string) bool

FileExist 路径是否存在

func FileIsValid

func FileIsValid(path string) bool

FileIsValid 检查文件是否有效

func Filter

func Filter[S ~[]E, E any](slice S, condition func(E) bool) S

Filter slice过滤

func Float64s

func Float64s(a *[]float64)

Float64s removes duplicate elements from a sorted slice of float64s.

func Float64sAreUnique

func Float64sAreUnique(a []float64) bool

Float64sAreUnique tests whether a slice of float64s is sorted and its elements are unique.

func GetMonthDay

func GetMonthDay() (string, string)

GetMonthDay 获得当前月的初始和结束日期

func GetQuarterByDate

func GetQuarterByDate(date string, diffQuarters ...int) (quarter, first, last string)

GetQuarterByDate 通过给定的日期 获得日期所在财报的季度、初始以及结束日期

diffQuarters 季度偏移数, 大于0前移diffQuarters个季度, 小于0后移diffQuarters个季度, 默认为当前季度

func GetQuarterDay

func GetQuarterDay(months ...int) (string, string)

GetQuarterDay 获得当前季度的初始和结束日期

func GetQuarterDayByDate

func GetQuarterDayByDate(date string, diffQuarters ...int) (firstOfQuarter, lastOfQuarter string)

GetQuarterDayByDate 通过给定的日期 获得日期所在上一个季度的初始和结束日期

diffQuarters 季度偏移数, 大于0前移diffQuarters个季度, 小于0后移diffQuarters个季度, 默认为当前季度

func GetWeekDay

func GetWeekDay() (string, string)

GetWeekDay 获得当前周的初始和结束日期

func Ints

func Ints(a *[]int)

Ints removes duplicate elements from a sorted slice of ints.

func IntsAreUnique

func IntsAreUnique(a []int) bool

IntsAreUnique tests whether a slice of ints is sorted and its elements are unique.

func IsEmpty

func IsEmpty(s string) bool

IsEmpty Code to test if string is empty

func IsUniqued

func IsUniqued(data sort.Interface) bool

IsUniqued reports whether the elements in data are sorted and unique.

func IsWorkday

func IsWorkday(t time.Time) bool

IsWorkday 是否工作日

func KebabCase

func KebabCase(s string) string

KebabCase converts a string into kebab case.

func LowerCamelCase

func LowerCamelCase(s string) string

LowerCamelCase converts a string into camel case starting with a lower case letter.

func ParseFloat

func ParseFloat(s string) float64

func ParseInt

func ParseInt(s string) int64

func ParseTime

func ParseTime(timestr string) (time.Time, error)

ParseTime 解析时间差

func ParseUint

func ParseUint(s string) uint64

func Reverse

func Reverse[S ~[]E, E any](s S) S

Reverse 反转切片

func SliceSort

func SliceSort[S ~[]E, E any](slice S, less func(a, b E) bool)

SliceSort slice排序

func SliceUnique

func SliceUnique[S ~[]E, E any](slicePtr *S, less func(i, j int) bool)

SliceUnique sorts the slice pointed by the provided pointer given the provided less function and removes repeated elements. The function panics if the provided interface is not a pointer to a slice.

func SlicesToCsv

func SlicesToCsv[S ~[]E, E any](filename string, s S) error

SlicesToCsv struct切片转csv文件

func SnakeCase

func SnakeCase(s string) string

SnakeCase converts a string into snake case.

func Sort

func Sort(data Interface)

Sort sorts and removes duplicate entries from data.

func StartsWith

func StartsWith(str string, prefixes []string) bool

StartsWith 字符串前缀判断

func String2Bytes

func String2Bytes(s string) []byte

String2Bytes 字符串转字节数组

func Strings

func Strings(a *[]string)

Strings removes duplicate elements from a sorted slice of strings.

func StringsAreUnique

func StringsAreUnique(a []string) bool

StringsAreUnique tests whether a slice of strings is sorted and its elements are unique.

func ToCamelCase

func ToCamelCase(kebab string) (camelCase string)

ToCamelCase 转驼峰

func ToFront

func ToFront(data sort.Interface) (n int)

ToFront reports the number of unique elements of data which it moves to the first n positions. It assumes sort.IsSorted(data).

func ToString

func ToString(value interface{}) string

ToString converts a value to string.

func Unique

func Unique(data Interface)

Unique removes duplicate elements from data. It assumes sort.IsSorted(data).

func UpperCamelCase

func UpperCamelCase(s string) string

UpperCamelCase converts a string into camel case starting with a upper case letter.

func UpperKebabCase

func UpperKebabCase(s string) string

UpperKebabCase converts a string into kebab case with capital letters.

func UpperSnakeCase

func UpperSnakeCase(s string) string

UpperSnakeCase converts a string into snake case with capital letters.

Types

type Float64Slice

type Float64Slice struct{ P *[]float64 }

Float64Slice attaches the methods of Interface to []float64.

func (Float64Slice) Len

func (p Float64Slice) Len() int

func (Float64Slice) Less

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

func (Float64Slice) Swap

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

func (Float64Slice) Truncate

func (p Float64Slice) Truncate(n int)

type IntSlice

type IntSlice struct{ P *[]int }

IntSlice attaches the methods of Interface to []int.

func (IntSlice) Len

func (p IntSlice) Len() int

func (IntSlice) Less

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

func (IntSlice) Swap

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

func (IntSlice) Truncate

func (p IntSlice) Truncate(n int)

type Interface

type Interface interface {
	sort.Interface

	// Truncate reduces the length to the first n elements.
	Truncate(n int)
}

Interface Types that implement unique.Interface can have duplicate elements removed by the functionality in this package.

type Option

type Option struct {
	// setting this value to true will ignore copying zero values of all the fields, including bools, as well as a
	// struct having all it's fields set to their zero values respectively (see IsZero() in reflect/value.go)
	IgnoreEmpty bool
	DeepCopy    bool
}

Option sets copy options

type ScopeLimit

type ScopeLimit struct {
	Start *int
	End   *int
}

ScopeLimit is used to specify a range. Both Start and End are inclusive. A nil value means no limit, so a Start of nil means 0 and an End of nil means no limit. The End value must always be equal to or larger than Start. Negative values are acceptable. A value of -2 means the second last row.

func IntsToRanges

func IntsToRanges(ints []int) []ScopeLimit

IntsToRanges will convert an already (ascending) ordered list of ints to a slice of Ranges.

Example:

import "sort"
ints := []int{2,4,5,6,8,10,11,45,46}
sort.Ints(ints)

fmt.Println(IntsToRanges(ints))
// Output: R{2,2}, R{4,6}, R{8,8}, R{10,11}, R{45,46}

func RangeFinite

func RangeFinite(start int, end ...int) ScopeLimit

RangeFinite returns a ScopeLimit that has a finite span.

func (*ScopeLimit) Limits

func (r *ScopeLimit) Limits(length int) (s int, e int, _ error)

Limits is used to return the start and end limits of a ScopeLimit object for a given Dataframe or Series with length number of rows.

func (*ScopeLimit) NRows

func (r *ScopeLimit) NRows(length ...int) (int, error)

NRows returns the number of rows contained by ScopeLimit. If End is nil, then length must be provided.

func (ScopeLimit) String

func (r ScopeLimit) String() string

String implements Stringer interface.

type StringSlice

type StringSlice struct{ P *[]string }

StringSlice attaches the methods of Interface to []string.

func (StringSlice) Len

func (p StringSlice) Len() int

func (StringSlice) Less

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

func (StringSlice) Swap

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

func (StringSlice) Truncate

func (p StringSlice) Truncate(n int)