randx

Documentation

Overview

Package randx contains randomization functions.

Index

• func SecureString(n int, alphabet []rune) string
• func String(n int, alphabet []rune) string
• type Rand
  • func New(src rand.Source) Rand
• type StringRand
  • func NewSecureStringRand(r io.Reader) StringRand

Functions

func SecureString

func SecureString(n int, alphabet []rune) string

SecureString returns a string of length n, composed of random characters from the provided alphabet, generated from a secure RNG. If the input slice is nil, returns a random mixed case alphanumeric string.

func String

func String(n int, alphabet []rune) string

String returns a string of length n, composed of random characters from the provided alphabet. If the input slice is nil, returns a random mixed case alphanumeric string.

Types

type Rand

type Rand interface {
	StringRand

	Int() int
	Intn(n int) int
	Int31() int32
	Int31n(n int32) int32
	Int63() int64
	Int63n(n int64) int64
	Float32() float32
	Float64() float64
	Read(p []byte) (n int, err error)
}

Rand can generate random values of various types.

func New

func New(src rand.Source) Rand

New creates a new RNG around a given source.

type StringRand

type StringRand interface {
	String(n int, alphabet []rune) string
}

StringRand can generate random strings for an alphabet. Supports both math/rand and crypto/rand.

var (
	SecureStringRand StringRand = NewSecureStringRand(cryptrand.Reader)
)

SecureStringRand is a StringRand that uses a secure RNG.

func NewSecureStringRand

func NewSecureStringRand(r io.Reader) StringRand

NewSecureStringRand returns a StringRand that uses a secure RNG.