nanoid

Dec 7, 2024

Changes in this version

+ type Interface interface

+ New func(length int) (ID, error)

+ Read func(b []byte) (n int, err error)

+ var RandReader = prng.Reader

Nov 16, 2024

Changes in this version

+ var ErrNilPointer = errors.New("nil pointer")

Nov 15, 2024

Changes in this version

+ var DefaultRandReader = prng.Reader

+ var EmptyID = ID("")

+ type ID string

+ func (id *ID) UnmarshalBinary(data []byte) error

+ func (id *ID) UnmarshalText(text []byte) error

+ func (id ID) Compare(other ID) int

+ func (id ID) IsEmpty() bool

+ func (id ID) MarshalBinary() ([]byte, error)

+ func (id ID) MarshalText() ([]byte, error)

+ func (id ID) String() string

Nov 9, 2024

Changes in this version

type Config

+ MaxBytesPerRune func() int

Nov 6, 2024

Changes in this version

+ func Read(p []byte) (n int, err error)

type Generator

+ Read func(p []byte) (n int, err error)

Nov 4, 2024

Changes in this version

+ var ErrNilRandReader = errors.New("nil random reader")

+ type Buffer interface

Nov 4, 2024

Changes in this version

type Config

+ BaseMultiplier func() int

+ BufferMultiplier func() int

+ ByteAlphabet func() []byte

+ LengthHint func() int

+ ScalingFactor func() int

type ConfigOptions

+ LengthHint int

type Option

+ func WithLengthHint(hint int) Option

Nov 2, 2024

Changes in this version

+ const DefaultLength

+ const MaxAlphabetLength

+ const MinAlphabetLength

+ func Must() string

+ func MustWithLength(length int) string

+ func NewWithLength(length int) (string, error)

type Config

+ RandReader func() io.Reader

+ type ConfigOptions struct

+ Alphabet string

+ RandReader io.Reader

type Configuration

+ Config func() Config

type Generator

+ func NewGenerator(options ...Option) (Generator, error)

+ New func(length int) (string, error)

+ type Option func(*ConfigOptions)

+ func WithAlphabet(alphabet string) Option

+ func WithRandReader(reader io.Reader) Option

Oct 31, 2024

Changes in this version

+ func MustGenerate() string

+ func MustGenerateSize(length int) string

type Generator

+ MustGenerate func(length int) string

Oct 31, 2024

Changes in this version

+ var ErrNonUTF8Alphabet = errors.New("alphabet contains invalid UTF-8 characters")

type Config

+ BitsNeeded uint

+ BufferSize int

+ BytesNeeded uint

+ IsASCII bool

+ RuneAlphabet []rune

Oct 30, 2024

Changes in this version

type Config

+ IsPowerOfTwo bool

Oct 29, 2024

Changes in this version

+ var ErrInvalidAlphabet = errors.New("invalid alphabet")

Oct 28, 2024

Changes in this version

+ var ErrAlphabetTooLong = errors.New("alphabet length must not exceed 256")

+ var ErrAlphabetTooShort = errors.New("alphabet length must be at least 2")

+ var ErrDuplicateCharacters = errors.New("alphabet contains duplicate characters")

+ var ErrExceededMaxAttempts = errors.New(...)

+ var ErrInvalidLength = errors.New("length must be positive")

+ type Config struct

+ Alphabet []byte

+ AlphabetLen int

+ Mask byte

+ Step int

+ type Configuration interface

+ GetConfig func() Config

+ type Generator interface

+ Generate func(size int) (string, error)

+ var DefaultGenerator Generator

Oct 26, 2024

Changes in this version

+ const MaxUintSize

+ var ErrEmptyAlphabet = errors.New("alphabet must not be empty")

+ var ErrInvalidSize = errors.New("size must be greater than zero")

+ var ErrRandomSourceNoData = errors.New("random source returned no data")

+ var ErrSizeExceedsMaxUint = errors.New("size exceeds maximum allowed value")

Oct 26, 2024

Changes in this version

+ const DefaultAlphabet

+ const DefaultSize

+ func New() (string, error)

+ func NewCustom(size int, alphabet string) (string, error)

+ func NewCustomReader(size int, alphabet string, rnd io.Reader) (string, error)

+ func NewSize(size int) (string, error)

Oct 24, 2024

Changes in this version

+ func Generate() (string, error)

+ func GenerateCustom(size int, alphabet string) (string, error)

+ func GenerateSize(size int) (string, error)