dictionary

Documentation

Index

• type Cache
• type CachedDefiner
  • func NewCachedDefiner(c Cache, d Definer) *CachedDefiner
  • func (d *CachedDefiner) Define(ctx context.Context, word string) ([]Definition, error)
• type Definer
• type Definition
• type WebAPI
  • func NewDefaultWebAPI() WebAPI
  • func (api WebAPI) Define(ctx context.Context, word string) ([]Definition, error)

Types

type Cache

type Cache interface {
	LookupWord(ctx context.Context, word string) ([]Definition, error)
	ContainsWord(ctx context.Context, word string) (bool, error)
	SaveWord(ctx context.Context, word string, defs []Definition) error
}

type CachedDefiner

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

func NewCachedDefiner

func NewCachedDefiner(c Cache, d Definer) *CachedDefiner

func (*CachedDefiner) Define

func (d *CachedDefiner) Define(ctx context.Context, word string) ([]Definition, error)

type Definer

type Definer interface {
	Define(ctx context.Context, word string) ([]Definition, error)
}

type Definition

type Definition struct {
	PartOfSpeech string
	Meaning      string
}

Definition is a single dictionary entry for a word

type WebAPI

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

WebAPI lets you interact with a dictionary API

func NewDefaultWebAPI

func NewDefaultWebAPI() WebAPI

NewDefaultWebAPI creates a new instance for connecting to a dictionary API

func (WebAPI) Define

func (api WebAPI) Define(ctx context.Context, word string) ([]Definition, error)