nameable

Documentation

Index

• func Apply(str string, m map[string]string) string
• func ApplyToList(in []string, m map[string]string) []string
• func Extract(str string, m, existing map[string]string)
• func Reduce(needed, replacements map[string]string) map[string]string
• type Accesser
• type Applier
• type Filler

Functions

func Apply

func Apply(str string, m map[string]string) string

Apply replaces the matching nameable sections with the values from the set.

func ApplyToList

func ApplyToList(in []string, m map[string]string) []string

ApplyToList replaces the matching nameable sections with the values from the set.

func Extract

func Extract(str string, m, existing map[string]string)

Extract the nameable sections of the string into the set.

func Reduce

func Reduce(needed, replacements map[string]string) map[string]string

Reduce returns a map of the replacements which exist in needed.

Types

type Accesser

type Accesser interface {
	// NameableReplacements returns the replacements to be used with Nameables.
	NameableReplacements() map[string]string
}

Accesser defines the method for retrieving the nameable replacements.

type Applier

type Applier interface {
	Accesser
	Filler
	// ApplyNameableKeys applies the nameable keys to this object.
	ApplyNameableKeys(m map[string]string)
}

Applier defines methods types that want to participate the nameable adjustments should implement.

type Filler

type Filler interface {
	// FillWithNameableKeys fills the map with nameable keys.
	FillWithNameableKeys(m, existing map[string]string)
}

Filler defines the method for filling the nameable key map.