utils

Documentation

Overview

Package utils is a legacy aggregate of byte, string, hash, context, password, slice, semver, and tokenizer helpers.

New helpers should live in the package that owns the concept. Existing exports remain for compatibility.

Index

• Constants
• func ABTest(data, salt []byte, groups ...uint64) uint64
• func BatchSlice[K any](size int, result []K) <-chan []K
• func Between(data string, keys ...string) string
• func ByteSliceToString(b []byte) string
• func CRC16(field string) uint16
• func CRC32(field string) uint32
• func CommonString(str string) string
• func EmailDomain(email string) string
• func EmailUserName(email string) string
• func GetBitLSB(b byte, bit int) bool
• func GetByteLSB(value int64, byteNumber int) byte
• func GetShortID() ([]byte, error)
• func GetTinyID() ([]byte, error)
• func GetUniqueID() string
• func HashName(name string) string
• func JamCRC32(value []byte) []byte
• func LSBBitValue(bitIdx int, isSet bool) byte
• func LSBBytesToInt(data []byte) int
• func LeftNibble(input byte) int
• func MaskField(str string, keepUnmaskedFront int, keepUnmaskedEnd int) string
• func NFDLowerString(str string) string
• func NFKDLowerString(str string) string
• func PadMessageToBlocksize(message []byte, blocksize int) []byte
• func RandStringBytes(n int) string
• func RightNibble(input byte) int
• func RotateLeft(val []byte, rotations int) []byte
• func RotateRight(val []byte, rotations int) []byte
• func SafeGet[T any](ptr *T, defaultValue T) T
• func SanitizeEmail(email string) string
• func Shingle(text string, k int) set.GenericDataSet[string]
• func SimHash(data []byte) uint64
• func SimHashCompare(val1, val2 uint64) uint8
• func SplitBetweenTokens(data string, keys ...string) []string
• func SplitByChunks(s string, chunkSize int) []string
• func UnsignedByteToInt(b byte) int
• func XOR(a1, a2 []byte) []byte
• func XORAlt(a1, a2 []byte) []byte
• type ContextKey
• type Password
  • func (p Password) MarshalJSON() ([]byte, error)
  • func (p Password) String() string
  • func (p Password) Value() string
• type Str

Constants

const (
	EmailTagStart = "+"
	EmailAt       = "@"
)

Functions

func ABTest

func ABTest(data, salt []byte, groups ...uint64) uint64

func BatchSlice

func BatchSlice[K any](size int, result []K) <-chan []K

func Between

func Between(data string, keys ...string) string

Between function to get content between two keys

func ByteSliceToString

func ByteSliceToString(b []byte) string

ByteSliceToString cast given bytes to string, without allocation memory

func CRC16

func CRC16(field string) uint16

func CRC32

func CRC32(field string) uint32

func CommonString

func CommonString(str string) string

func EmailDomain

func EmailDomain(email string) string

func EmailUserName

func EmailUserName(email string) string

func GetBitLSB

func GetBitLSB(b byte, bit int) bool

func GetByteLSB

func GetByteLSB(value int64, byteNumber int) byte

func GetShortID

func GetShortID() ([]byte, error)

GetShortID return short id

func GetTinyID

func GetTinyID() ([]byte, error)

GetTinyID return tiny id

func GetUniqueID

func GetUniqueID() string

GetUniqueID return unique id

func HashName

func HashName(name string) string

func JamCRC32

func JamCRC32(value []byte) []byte

func LSBBitValue

func LSBBitValue(bitIdx int, isSet bool) byte

func LSBBytesToInt

func LSBBytesToInt(data []byte) int

func LeftNibble

func LeftNibble(input byte) int

func MaskField

func MaskField(str string, keepUnmaskedFront int, keepUnmaskedEnd int) string

func NFDLowerString

func NFDLowerString(str string) string

func NFKDLowerString

func NFKDLowerString(str string) string

func PadMessageToBlocksize

func PadMessageToBlocksize(message []byte, blocksize int) []byte

func RandStringBytes

func RandStringBytes(n int) string

func RightNibble

func RightNibble(input byte) int

func RotateLeft

func RotateLeft(val []byte, rotations int) []byte

RotateLeft byte-rotates a byte array left by the given number of rotations

func RotateRight

func RotateRight(val []byte, rotations int) []byte

RotateRight byte-rotates a byte array left by the given number of rotations

func SafeGet

func SafeGet[T any](ptr *T, defaultValue T) T

SafeGet return value of pointer, and return default value if it nil

func SanitizeEmail

func SanitizeEmail(email string) string

func Shingle

func Shingle(text string, k int) set.GenericDataSet[string]

func SimHash

func SimHash(data []byte) uint64

func SimHashCompare

func SimHashCompare(val1, val2 uint64) uint8

func SplitBetweenTokens

func SplitBetweenTokens(data string, keys ...string) []string

SplitBetweenTokens takes string and one or two tokens, and cuts everything between two tokens, or between two copies of first token.

func SplitByChunks

func SplitByChunks(s string, chunkSize int) []string

func UnsignedByteToInt

func UnsignedByteToInt(b byte) int

func XOR

func XOR(a1, a2 []byte) []byte

func XORAlt

func XORAlt(a1, a2 []byte) []byte

Types

type ContextKey

type ContextKey string

ContextKey contains context key

type Password

type Password string

Password describe masked field

func (Password) MarshalJSON

func (p Password) MarshalJSON() ([]byte, error)

MarshalJSON block to show value in json

func (Password) String

func (p Password) String() string

String return hide password value

func (Password) Value

func (p Password) Value() string

Value return exactly password value

type Str

type Str struct {
	Pass Password
}