nameutil

Documentation

Overview

The package nameutil contains util structures for generating names. E.g. chart release names.

Index

• type Generator
• type NameGenerator
  • func NewDefaultNameGenerator() *NameGenerator
  • func NewNameGenerator(timeNow func() time.Time, randRead func([]byte) (int, error)) *NameGenerator
  • func (ng *NameGenerator) Generate(prefix string) (string, error)

Types

type Generator

type Generator interface {
	Generate(prefix string) (generated string, err error)
}

Generator is the interface that wraps the basic Generate method.

type NameGenerator

type NameGenerator struct {
	// contains filtered or unexported fields
}

NameGenerator satisfies the Generator interface for generating names.

func NewDefaultNameGenerator

func NewDefaultNameGenerator() *NameGenerator

NewDefaultNameGenerator creates a new NameGenerator with the default dependencies.

func NewNameGenerator

func NewNameGenerator(
	timeNow func() time.Time,
	randRead func([]byte) (int, error),
) *NameGenerator

NewNameGenerator creates a new NameGenerator.

func (*NameGenerator) Generate

func (ng *NameGenerator) Generate(prefix string) (string, error)

Generate generates a new name with a prefix based on the UnixNano UTC timestamp plus 2 random bytes.