generator

Documentation

Overview

Package generator encapsulates the structure which is in charge of populating the petname array

Index

• Constants
• type Generator
  • func (g *Generator) Get() (string, error)
  • func (g *Generator) New(t string, n string) error

Constants

const (
	// NameTemplate is the call value for templating names
	NameTemplate = "Name"
	// AdjectiveTemplate is the call value for templating adjectives
	AdjectiveTemplate = "Adjective"
	// AdverbTemplate is the call value for templating adverbs
	AdverbTemplate = "Adverb"
)

Types

type Generator

type Generator struct {
	Name          string
	Used          *cache.Cache
	Template      *template.Template
	Adjectives    []string
	Adverbs       []string
	Names         []string
	AvailableAdv  int
	AvailableAdj  int
	AvailableName int
}

Generator encapsulates all functions that allow for the unique generation of a petname

func (*Generator) Get

func (g *Generator) Get() (string, error)

Get generates an unique petname and returns that string

func (*Generator) New

func (g *Generator) New(t string, n string) error

New generates a new generator from a given template If template does not follow the const given will return empty generator