Lancet is a comprehensive, efficient, and reusable util function library of go. Inspired by the java apache common package and lodash.js.
English | [็ฎไฝไธญๆ](./README_zh-CN.md) ## Feature - ๐ Comprehensive, efficient and reusable. - ๐ช 180+ go util functions, support string, slice, datetime, net, crypt... - ๐ Only depend on the go standard library. - ๐ Unit test for every exported function. ## Installation ```go go get github.com/duke-git/lancet ``` ## Usage Lancet organizes the code into package structure, and you need to import the corresponding package name when use it. For example, if you use string-related functions,import the strutil package like below: ```go import "github.com/duke-git/lancet/strutil" ``` ## Example Here takes the string function ReverseStr (reverse order string) as an example, and the strutil package needs to be imported. ```go package main import ( "fmt" "github.com/duke-git/lancet/strutil" ) func main() { s := "hello" rs := strutil.ReverseStr(s) fmt.Println(rs) //olleh } ``` ## API Documentation ### Convertor package contains some functions for data convertion. ```go import "github.com/duke-git/lancet/convertor" ``` #### Function list: - [ColorHexToRGB](https://github.com/duke-git/lancet/blob/main/docs/convertor.md#ColorHexToRGB) - [ColorRGBToHex](https://github.com/duke-git/lancet/blob/main/docs/convertor.md#ColorRGBToHex) - [ToBool](https://github.com/duke-git/lancet/blob/main/docs/convertor.md#ToBool) - [ToBytes](https://github.com/duke-git/lancet/blob/main/docs/convertor.md#ToBytes) - [ToChar](https://github.com/duke-git/lancet/blob/main/docs/convertor.md#ToChar) - [ToInt](https://github.com/duke-git/lancet/blob/main/docs/convertor.md#ToInt) - [ToJson](https://github.com/duke-git/lancet/blob/main/docs/convertor.md#ToJson) - [ToString](https://github.com/duke-git/lancet/blob/main/docs/convertor.md#ToString) - [StructToMap](https://github.com/duke-git/lancet/blob/main/docs/convertor.md#StructToMap) ### Cryptor package is for data encryption and decryption. ```go import "github.com/duke-git/lancet/cryptor" ``` #### Function list: - [AesEcbEncrypt](https://github.com/duke-git/lancet/blob/main/docs/cryptor.md#AesEcbEncrypt) - [AesEcbDecrypt](https://github.com/duke-git/lancet/blob/main/docs/cryptor.md#AesEcbDecrypt) - [AesCbcEncrypt](https://github.com/duke-git/lancet/blob/main/docs/cryptor.md#AesCbcEncrypt) - [AesCbcDecrypt](https://github.com/duke-git/lancet/blob/main/docs/cryptor.md#AesCbcDecrypt) - [AesCtrCrypt](https://github.com/duke-git/lancet/blob/main/docs/cryptor.md#AesCtrCrypt) - [AesCfbEncrypt](https://github.com/duke-git/lancet/blob/main/docs/cryptor.md#AesCfbEncrypt) - [AesCfbDecrypt](https://github.com/duke-git/lancet/blob/main/docs/cryptor.md#AesCfbDecrypt) - [AesOfbEncrypt](https://github.com/duke-git/lancet/blob/main/docs/cryptor.md#AesOfbEncrypt) - [AesOfbDecrypt](https://github.com/duke-git/lancet/blob/main/docs/cryptor.md#AesOfbDecrypt) - [Base64StdEncode](https://github.com/duke-git/lancet/blob/main/docs/cryptor.md#Base64StdEncode) - [Base64StdDecode](https://github.com/duke-git/lancet/blob/main/docs/cryptor.md#Base64StdDecode) - [DesEcbEncrypt](https://github.com/duke-git/lancet/blob/main/docs/cryptor.md#DesEcbEncrypt) - [DesEcbDecrypt](https://github.com/duke-git/lancet/blob/main/docs/cryptor.md#DesEcbDecrypt) - [DesCbcEncrypt](https://github.com/duke-git/lancet/blob/main/docs/cryptor.md#DesCbcEncrypt) - [DesCbcDecrypt](https://github.com/duke-git/lancet/blob/main/docs/cryptor.md#DesCbcDecrypt) - [DesCtrCrypt](https://github.com/duke-git/lancet/blob/main/docs/cryptor.md#DesCtrCrypt) - [DesCfbEncrypt](https://github.com/duke-git/lancet/blob/main/docs/cryptor.md#DesCfbEncrypt) - [DesCfbDecrypt](https://github.com/duke-git/lancet/blob/main/docs/cryptor.md#DesCfbDecrypt) - [DesOfbEncrypt](https://github.com/duke-git/lancet/blob/main/docs/cryptor.md#DesOfbEncrypt) - [DesOfbDecrypt](https://github.com/duke-git/lancet/blob/main/docs/cryptor.md#DesOfbDecrypt) - [HmacMd5](https://github.com/duke-git/lancet/blob/main/docs/cryptor.md#HmacMd5) - [HmacSha1](https://github.com/duke-git/lancet/blob/main/docs/cryptor.md#HmacSha1) - [HmacSha256](https://github.com/duke-git/lancet/blob/main/docs/cryptor.md#HmacSha256) - [HmacSha512](https://github.com/duke-git/lancet/blob/main/docs/cryptor.md#HmacSha512) - [Md5String](https://github.com/duke-git/lancet/blob/main/docs/cryptor.md#Md5String) - [Md5File](https://github.com/duke-git/lancet/blob/main/docs/cryptor.md#Md5File) - [Sha1](https://github.com/duke-git/lancet/blob/main/docs/cryptor.md#Sha1) - [Sha256](https://github.com/duke-git/lancet/blob/main/docs/cryptor.md#Sha256) - [Sha512](https://github.com/duke-git/lancet/blob/main/docs/cryptor.md#Sha512) - [GenerateRsaKey](https://github.com/duke-git/lancet/blob/main/docs/cryptor.md#GenerateRsaKey) - [RsaEncrypt](https://github.com/duke-git/lancet/blob/main/docs/cryptor.md#RsaEncrypt) - [RsaDecrypt](https://github.com/duke-git/lancet/blob/main/docs/cryptor.md#RsaDecrypt) ### Datetime package supports date and time format and compare. ```go import "github.com/duke-git/lancet/datetime" ``` #### Function list: - [AddDay](https://github.com/duke-git/lancet/blob/main/docs/datetime.md#AddDay) - [AddHour](https://github.com/duke-git/lancet/blob/main/docs/datetime.md#AddHour) - [AddMinute](https://github.com/duke-git/lancet/blob/main/docs/datetime.md#AddMinute) - [BeginOfMinute](https://github.com/duke-git/lancet/blob/main/docs/datetime.md#BeginOfMinute) - [BeginOfHour](https://github.com/duke-git/lancet/blob/main/docs/datetime.md#BeginOfHour) - [BeginOfDay](https://github.com/duke-git/lancet/blob/main/docs/datetime.md#BeginOfDay) - [BeginOfWeek](https://github.com/duke-git/lancet/blob/main/docs/datetime.md#BeginOfWeek) - [BeginOfMonth](https://github.com/duke-git/lancet/blob/main/docs/datetime.md#BeginOfMonth) - [BeginOfYear](https://github.com/duke-git/lancet/blob/main/docs/datetime.md#BeginOfYear) - [EndOfMinute](https://github.com/duke-git/lancet/blob/main/docs/datetime.md#EndOfMinute) - [EndOfHour](https://github.com/duke-git/lancet/blob/main/docs/datetime.md#EndOfHour) - [EndOfDay](https://github.com/duke-git/lancet/blob/main/docs/datetime.md#EndOfDay) - [EndOfWeek](https://github.com/duke-git/lancet/blob/main/docs/datetime.md#EndOfWeek) - [EndOfMonth](https://github.com/duke-git/lancet/blob/main/docs/datetime.md#EndOfMonth) - [EndOfYear](https://github.com/duke-git/lancet/blob/main/docs/datetime.md#EndOfYear) - [GetNowDate](https://github.com/duke-git/lancet/blob/main/docs/datetime.md#GetNowDate) - [GetNowTime](https://github.com/duke-git/lancet/blob/main/docs/datetime.md#GetNowTime) - [GetNowDateTime](https://github.com/duke-git/lancet/blob/main/docs/datetime.md#GetNowDateTime) - [GetZeroHourTimestamp](https://github.com/duke-git/lancet/blob/main/docs/datetime.md#GetZeroHourTimestamp) - [GetNightTimestamp](https://github.com/duke-git/lancet/blob/main/docs/datetime.md#GetNightTimestamp) - [FormatTimeToStr](https://github.com/duke-git/lancet/blob/main/docs/datetime.md#FormatTimeToStr) - [FormatStrToTime](https://github.com/duke-git/lancet/blob/main/docs/datetime.md#FormatStrToTime) - [NewUnix](https://github.com/duke-git/lancet/blob/main/docs/datetime.md#NewUnix) - [NewUnixNow](https://github.com/duke-git/lancet/blob/main/docs/datetime.md#NewUnixNow) - [NewFormat](https://github.com/duke-git/lancet/blob/main/docs/datetime.md#NewFormat) - [NewISO8601](https://github.com/duke-git/lancet/blob/main/docs/datetime.md#NewISO8601) - [ToUnix](https://github.com/duke-git/lancet/blob/main/docs/datetime.md#ToUnix) - [ToFormat](https://github.com/duke-git/lancet/blob/main/docs/datetime.md#ToFormat) - [ToFormatForTpl](https://github.com/duke-git/lancet/blob/main/docs/datetime.md#ToFormatForTpl) - [ToIso8601](https://github.com/duke-git/lancet/blob/main/docs/datetime.md#ToIso8601) ### Fileutil package implements some basic functions for file operations. ```go import "github.com/duke-git/lancet/fileutil" ``` #### Function list๏ผ - [ClearFile](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#ClearFile) - [CreateFile](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#CreateFile) - [CopyFile](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#CopyFile) - [FileMode](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#FileMode) - [MiMeType](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#MiMeType) - [IsExist](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#IsExist) - [IsLink](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#IsLink) - [IsDir](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#IsDir) - [ListFileNames](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#ListFileNames) - [RemoveFile](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#RemoveFile) - [ReadFileToString](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#ReadFileToString) - [ReadFileByLine](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#ReadFileByLine) - [Zip](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#Zip) - [UnZip](https://github.com/duke-git/lancet/blob/main/docs/fileutil.md#UnZip) ### Formatter contains some functions for data formatting. ```go import "github.com/duke-git/lancet/formatter" ``` #### Function list: - [Comma](https://github.com/duke-git/lancet/blob/main/docs/formatter.md#Comma) ### Function package can control the flow of function execution and support part of functional programming ```go import "github.com/duke-git/lancet/function" ``` #### Function list: - [After](https://github.com/duke-git/lancet/blob/main/docs/function.md#After) - [Before](https://github.com/duke-git/lancet/blob/main/docs/function.md#Before) - [Curry](https://github.com/duke-git/lancet/blob/main/docs/function.md#Curry) - [Compose](https://github.com/duke-git/lancet/blob/main/docs/function.md#Compose) - [Debounced](https://github.com/duke-git/lancet/blob/main/docs/function.md#Debounced) - [Delay](https://github.com/duke-git/lancet/blob/main/docs/function.md#Delay) - [Watcher](https://github.com/duke-git/lancet/blob/main/docs/function.md#Watcher) ### Mathutil package implements some functions for math calculation. ```go import "github.com/duke-git/lancet/mathutil" ``` #### Function list: - [Exponent](https://github.com/duke-git/lancet/blob/main/docs/mathutil.md#Exponent) - [Fibonacci](https://github.com/duke-git/lancet/blob/main/docs/mathutil.md#Fibonacci) - [Factorial](https://github.com/duke-git/lancet/blob/main/docs/mathutil.md#Factorial) - [Percent](https://github.com/duke-git/lancet/blob/main/docs/mathutil.md#Percent) - [RoundToFloat](https://github.com/duke-git/lancet/blob/main/docs/mathutil.md#RoundToFloat) - [RoundToString](https://github.com/duke-git/lancet/blob/main/docs/mathutil.md#RoundToString) - [TruncRound](https://github.com/duke-git/lancet/blob/main/docs/mathutil.md#TruncRound) ### Netutil package contains functions to get net information and send http request. ```go import "github.com/duke-git/lancet/netutil" ``` #### Function list: - [ConvertMapToQueryString](https://github.com/duke-git/lancet/blob/main/docs/netutil.md#ConvertMapToQueryString) - [GetInternalIp](https://github.com/duke-git/lancet/blob/main/docs/netutil.md#GetInternalIp) - [GetIps](https://github.com/duke-git/lancet/blob/main/docs/netutil.md#GetIps) - [GetMacAddrs](https://github.com/duke-git/lancet/blob/main/docs/netutil.md#GetMacAddrs) - [GetPublicIpInfo](https://github.com/duke-git/lancet/blob/main/docs/netutil.md#GetPublicIpInfo) - [IsPublicIP](https://github.com/duke-git/lancet/blob/main/docs/netutil.md#IsPublicIP) - [HttpGet](https://github.com/duke-git/lancet/blob/main/docs/netutil.md#HttpGet) - [HttpDelete](https://github.com/duke-git/lancet/blob/main/docs/netutil.md#HttpDelete) - [HttpPost](https://github.com/duke-git/lancet/blob/main/docs/netutil.md#HttpPost) - [HttpPut](https://github.com/duke-git/lancet/blob/main/docs/netutil.md#HttpPut) - [HttpPatch](https://github.com/duke-git/lancet/blob/main/docs/netutil.md#HttpPatch) - [ParseHttpResponse](https://github.com/duke-git/lancet/blob/main/docs/netutil.md#ParseHttpResponse) ### Random package implements some basic functions to generate random int and string. ```go import "github.com/duke-git/lancet/random" ``` #### Function list: - [RandBytes](https://github.com/duke-git/lancet/blob/main/docs/random.md#RandBytes) - [RandInt](https://github.com/duke-git/lancet/blob/main/docs/random.md#RandInt) - [RandString](https://github.com/duke-git/lancet/blob/main/docs/random.md#RandString) - [UUIdV4](https://github.com/duke-git/lancet/blob/main/docs/random.md#UUIdV4) ### Retry package is for executing a function repeatedly until it was successful or canceled by the context. ```go import "github.com/duke-git/lancet/retry" ``` #### Function list: - [Context](https://github.com/duke-git/lancet/blob/main/docs/retry.md#Context) - [Retry](https://github.com/duke-git/lancet/blob/main/docs/retry.md#Retry) - [RetryFunc](https://github.com/duke-git/lancet/blob/main/docs/retry.md#RetryFunc) - [RetryDuration](https://github.com/duke-git/lancet/blob/main/docs/retry.md#RetryDuration) - [RetryTimes](https://github.com/duke-git/lancet/blob/main/docs/retry.md#RetryTimes) ### Slice contains some functions to manipulate slice. ```go import "github.com/duke-git/lancet/slice" ``` #### Function list: - [Contain](https://github.com/duke-git/lancet/blob/main/docs/slice.md#Contain) - [ContainSubSlice](https://github.com/duke-git/lancet/blob/main/docs/slice.md#ContainSubSlice) - [Chunk](https://github.com/duke-git/lancet/blob/main/docs/slice.md#Chunk) - [Compact](https://github.com/duke-git/lancet/blob/main/docs/slice.md#Compact) - [Concat](https://github.com/duke-git/lancet/blob/main/docs/slice.md#Concat) - [Count](https://github.com/duke-git/lancet/blob/main/docs/slice.md#Count) - [Difference](https://github.com/duke-git/lancet/blob/main/docs/slice.md#Difference) - [DifferenceBy](https://github.com/duke-git/lancet/blob/main/docs/slice.md#DifferenceBy) - [DeleteByIndex](https://github.com/duke-git/lancet/blob/main/docs/slice.md#DeleteByIndex) - [Drop](https://github.com/duke-git/lancet/blob/main/docs/slice.md#Drop) - [Every](https://github.com/duke-git/lancet/blob/main/docs/slice.md#Every) - [Filter](https://github.com/duke-git/lancet/blob/main/docs/slice.md#Filter) - [Find](https://github.com/duke-git/lancet/blob/main/docs/slice.md#Find) - [FindLast](https://github.com/duke-git/lancet/blob/main/docs/slice.md#FindLast) - [FlattenDeep](#FlattenDeep) - [ForEach](https://github.com/duke-git/lancet/blob/main/docs/slice.md#ForEach) - [GroupBy](https://github.com/duke-git/lancet/blob/main/docs/slice.md#GroupBy) - [IntSlice](https://github.com/duke-git/lancet/blob/main/docs/slice.md#IntSlice) - [InterfaceSlice](https://github.com/duke-git/lancet/blob/main/docs/slice.md#InterfaceSlice) - [Intersection](https://github.com/duke-git/lancet/blob/main/docs/slice.md#Intersection) - [InsertByIndex](https://github.com/duke-git/lancet/blob/main/docs/slice.md#InsertByIndex) - [Map](https://github.com/duke-git/lancet/blob/main/docs/slice.md#Map) - [ReverseSlice](https://github.com/duke-git/lancet/blob/main/docs/slice.md#ReverseSlice) - [Reduce](https://github.com/duke-git/lancet/blob/main/docs/slice.md#Reduce) - [Shuffle](https://github.com/duke-git/lancet/blob/main/docs/slice.md#Shuffle) - [SortByField](https://github.com/duke-git/lancet/blob/main/docs/slice.md#SortByField) - [Some](https://github.com/duke-git/lancet/blob/main/docs/slice.md#Some) - [StringSlice](https://github.com/duke-git/lancet/blob/main/docs/slice.md#StringSlice) - [Unique](https://github.com/duke-git/lancet/blob/main/docs/slice.md#Unique) - [Union](https://github.com/duke-git/lancet/blob/main/docs/slice.md#Union) - [UpdateByIndex](https://github.com/duke-git/lancet/blob/main/docs/slice.md#UpdateByIndex) - [Without](https://github.com/duke-git/lancet/blob/main/docs/slice.md#Without) ### Strutil package contains some functions to manipulate string. ```go import "github.com/duke-git/lancet/strutil" ``` #### Function list: - [After](https://github.com/duke-git/lancet/blob/main/docs/strutil.md#After) - [AfterLast](https://github.com/duke-git/lancet/blob/main/docs/strutil.md#AfterLast) - [Before](https://github.com/duke-git/lancet/blob/main/docs/strutil.md#Before) - [BeforeLast](https://github.com/duke-git/lancet/blob/main/docs/strutil.md#BeforeLast) - [CamelCase](https://github.com/duke-git/lancet/blob/main/docs/strutil.md#CamelCase) - [Capitalize](https://github.com/duke-git/lancet/blob/main/docs/strutil.md#Capitalize) - [IsString](https://github.com/duke-git/lancet/blob/main/docs/strutil.md#IsString) - [KebabCase](https://github.com/duke-git/lancet/blob/main/docs/strutil.md#KebabCase) - [LowerFirst](https://github.com/duke-git/lancet/blob/main/docs/strutil.md#LowerFirst) - [UpperFirst](https://github.com/duke-git/lancet/blob/main/docs/strutil.md#UpperFirst) - [PadEnd](https://github.com/duke-git/lancet/blob/main/docs/strutil.md#PadEnd) - [PadStart](https://github.com/duke-git/lancet/blob/main/docs/strutil.md#PadStart) - [ReverseStr](https://github.com/duke-git/lancet/blob/main/docs/strutil.md#ReverseStr) - [SnakeCase](https://github.com/duke-git/lancet/blob/main/docs/strutil.md#SnakeCase) - [Wrap](https://github.com/duke-git/lancet/blob/main/docs/strutil.md#Wrap) - [Unwrap](https://github.com/duke-git/lancet/blob/main/docs/strutil.md#Unwrap) ### System package contain some functions about os, runtime, shell command. ```go import "github.com/duke-git/lancet/system" ``` #### Function list: - [IsWindows](https://github.com/duke-git/lancet/blob/main/docs/system.md#IsWindows) - [IsLinux](https://github.com/duke-git/lancet/blob/main/docs/system.md#IsLinux) - [IsMac](https://github.com/duke-git/lancet/blob/main/docs/system.md#IsMac) - [GetOsEnv](https://github.com/duke-git/lancet/blob/main/docs/system.md#GetOsEnv) - [SetOsEnv](https://github.com/duke-git/lancet/blob/main/docs/system.md#SetOsEnv) - [RemoveOsEnv](https://github.com/duke-git/lancet/blob/main/docs/system.md#RemoveOsEnv) - [CompareOsEnv](https://github.com/duke-git/lancet/blob/main/docs/system.md#CompareOsEnv) - [ExecCommand](https://github.com/duke-git/lancet/blob/main/docs/system.md#ExecCommand) ### Validator package contains some functions for data validation. ```go import "github.com/duke-git/lancet/validator" ``` #### Function list: - [ContainChinese](https://github.com/duke-git/lancet/blob/main/docs/validator.md#ContainChinese) - [ContainLetter](https://github.com/duke-git/lancet/blob/main/docs/validator.md#ContainLetter) - [ContainLower](https://github.com/duke-git/lancet/blob/main/docs/validator.md#ContainLower) - [ContainUpper](https://github.com/duke-git/lancet/blob/main/docs/validator.md#ContainUpper) - [IsAlpha](https://github.com/duke-git/lancet/blob/main/docs/validator.md#IsAlpha) - [IsAllUpper](https://github.com/duke-git/lancet/blob/main/docs/validator.md#IsAllUpper) - [IsAllLower](https://github.com/duke-git/lancet/blob/main/docs/validator.md#IsAllLower) - [IsBase64](https://github.com/duke-git/lancet/blob/main/docs/validator.md#IsBase64) - [IsChineseMobile](https://github.com/duke-git/lancet/blob/main/docs/validator.md#IsChineseMobile) - [IsChineseIdNum](https://github.com/duke-git/lancet/blob/main/docs/validator.md#IsChineseIdNum) - [IsChinesePhone](https://github.com/duke-git/lancet/blob/main/docs/validator.md#IsChinesePhone) - [IsCreditCard](https://github.com/duke-git/lancet/blob/main/docs/validator.md#IsCreditCard) - [IsDns](https://github.com/duke-git/lancet/blob/main/docs/validator.md#IsDns) - [IsEmail](https://github.com/duke-git/lancet/blob/main/docs/validator.md#IsEmail) - [IsEmptyString](https://github.com/duke-git/lancet/blob/main/docs/validator.md#IsEmptyString) - [IsFloatStr](https://github.com/duke-git/lancet/blob/main/docs/validator.md#IsFloatStr) - [IsNumberStr](https://github.com/duke-git/lancet/blob/main/docs/validator.md#IsNumberStr) - [IsJSON](https://github.com/duke-git/lancet/blob/main/docs/validator.md#IsJSON) - [IsRegexMatch](https://github.com/duke-git/lancet/blob/main/docs/validator.md#IsRegexMatch) - [IsIntStr](https://github.com/duke-git/lancet/blob/main/docs/validator.md#IsIntStr) - [IsIp](https://github.com/duke-git/lancet/blob/main/docs/validator.md#IsIp) - [IsIpV4](https://github.com/duke-git/lancet/blob/main/docs/validator.md#IsIpV4) - [IsIpV6](https://github.com/duke-git/lancet/blob/main/docs/validator.md#IsIpV6) - [IsStrongPassword](https://github.com/duke-git/lancet/blob/main/docs/validator.md#IsStrongPassword) - [IsUrl](https://github.com/duke-git/lancet/blob/main/docs/validator.md#IsUrl) - [IsWeakPassword](https://github.com/duke-git/lancet/blob/main/docs/validator.md#IsWeakPassword) ## How to Contribute I really appreciate any code commits which make lancet lib powerful. Please follow the rules below to create your pull request. 1. Fork the repository. 2. Create your feature branch. 3. Commit your changes. 4. Push to the branch 5. Create new pull request.