common/README.md

63 lines
1.1 KiB
Markdown
Raw Normal View History

2022-01-01 21:39:27 +00:00
# common
--
import "git.tcp.direct/kayos/common"
stuff I use a lot.
#### func Abs
```go
func Abs(n int) int
```
2022-01-01 22:01:21 +00:00
Abs will give you the positive version of a negative integer, quickly.
#### func BytesToBlake2b
```go
func BytesToBlake2b(b []byte) []byte
```
BytesToBlake2b ignores all errors and gives you a blakae2b 64 hash value as a
byte slice. (or panics somehow)
2022-01-01 21:39:27 +00:00
#### func CompareChecksums
```go
func CompareChecksums(a []byte, b []byte) bool
```
2022-01-01 22:01:21 +00:00
CompareChecksums will take in two byte slices, hash them with blake2b, and tell
you if the resulting checksums match.
2022-01-01 21:39:27 +00:00
#### func Fprint
```go
func Fprint(w io.Writer, s string)
```
Fprint is fmt.Fprint with error handling.
#### func RNG
```go
func RNG(n int) int
```
2022-01-01 22:01:21 +00:00
RNG is a Random Number Generator
2022-01-01 21:39:27 +00:00
2022-01-01 22:01:21 +00:00
#### func RandSleepMS
2022-01-01 21:39:27 +00:00
```go
2022-01-01 22:01:21 +00:00
func RandSleepMS(n int)
2022-01-01 21:39:27 +00:00
```
2022-01-01 22:01:21 +00:00
RandSleepMS sleeps for a random period of time with a maximum of n milliseconds.
2022-01-01 21:39:27 +00:00
2022-01-01 22:01:21 +00:00
#### func RandStr
2022-01-01 21:39:27 +00:00
```go
2022-01-01 22:01:21 +00:00
func RandStr(size int) string
2022-01-01 21:39:27 +00:00
```
2022-01-01 22:01:21 +00:00
RandStr generates a random alphanumeric string with a max length of size.
#### func RangeIterate
2022-01-01 21:39:27 +00:00
2022-01-01 22:01:21 +00:00
```go
func RangeIterate(ips interface{}) chan *ipa.IP
```