namegen

Documentation

Index

• Variables
• type Builtin
  • func ExtractBuiltin(str string) Builtin
  • func (enum Builtin) EnsureValid() Builtin
  • func (enum Builtin) Key() string
  • func (enum Builtin) MarshalText() (text []byte, err error)
  • func (enum Builtin) String() string
  • func (enum *Builtin) UnmarshalText(text []byte) error
• type Type
  • func ExtractType(str string) Type
  • func (enum Type) EnsureValid() Type
  • func (enum Type) Key() string
  • func (enum Type) MarshalText() (text []byte, err error)
  • func (enum Type) String() string
  • func (enum *Type) UnmarshalText(text []byte) error

Variables

var Builtins = []Builtin{
	None,
	AmericanMale,
	AmericanFemale,
	AmericanLast,
	UnweightedAmericanMale,
	UnweightedAmericanFemale,
	UnweightedAmericanLast,
}

Builtins holds all possible values.

var Types = []Type{
	Simple,
	MarkovLetter,
	MarkovRun,
	Compound,
}

Types holds all possible values.

Types

type Builtin

type Builtin byte

Builtin holds a built-in name data type.

const (
	None Builtin = iota
	AmericanMale
	AmericanFemale
	AmericanLast
	UnweightedAmericanMale
	UnweightedAmericanFemale
	UnweightedAmericanLast
)

Possible values.

const LastBuiltin Builtin = UnweightedAmericanLast

LastBuiltin is the last valid value.

func ExtractBuiltin

func ExtractBuiltin(str string) Builtin

ExtractBuiltin extracts the value from a string.

func (Builtin) EnsureValid

func (enum Builtin) EnsureValid() Builtin

EnsureValid ensures this is of a known value.

func (Builtin) Key

func (enum Builtin) Key() string

Key returns the key used in serialization.

func (Builtin) MarshalText

func (enum Builtin) MarshalText() (text []byte, err error)

MarshalText implements the encoding.TextMarshaler interface.

func (Builtin) String

func (enum Builtin) String() string

String implements fmt.Stringer.

func (*Builtin) UnmarshalText

func (enum *Builtin) UnmarshalText(text []byte) error

UnmarshalText implements the encoding.TextUnmarshaler interface.

type Type

type Type byte

Type holds a name generation type.

const (
	Simple Type = iota
	MarkovLetter
	MarkovRun
	Compound
)

Possible values.

const LastType Type = Compound

LastType is the last valid value.

func ExtractType

func ExtractType(str string) Type

ExtractType extracts the value from a string.

func (Type) EnsureValid

func (enum Type) EnsureValid() Type

EnsureValid ensures this is of a known value.

func (Type) Key

func (enum Type) Key() string

Key returns the key used in serialization.

func (Type) MarshalText

func (enum Type) MarshalText() (text []byte, err error)

MarshalText implements the encoding.TextMarshaler interface.

func (Type) String

func (enum Type) String() string

String implements fmt.Stringer.

func (*Type) UnmarshalText

func (enum *Type) UnmarshalText(text []byte) error

UnmarshalText implements the encoding.TextUnmarshaler interface.