spellmatch

Documentation

Index

• Variables
• type Matcher
• 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) MatchForType(matcher Matcher, replacements map[string]string, name, powerSource string, ...) bool
  • func (enum Type) String() string
  • func (enum *Type) UnmarshalText(text []byte) error

Variables

var Types = []Type{
	AllColleges,
	CollegeName,
	PowerSource,
	Name,
}

Types holds all possible values.

Types

type Matcher

type Matcher interface {
	Matches(map[string]string, string) bool
	MatchesList(map[string]string, ...string) bool
}

Matcher defines the methods that a spell matcher must implement.

type Type

type Type byte

Type holds the type of a match.

const (
	AllColleges Type = iota
	CollegeName
	PowerSource
	Name
)

Possible values.

const LastType Type = Name

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) MatchForType

func (enum Type) MatchForType(matcher Matcher, replacements map[string]string, name, powerSource string, colleges []string) bool

MatchForType applies the matcher and returns the result.

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.