professor

Documentation

Index

• Variables
• type OptFunc
• type Professor
  • func New(source Source, logger *slog.Logger, opts ...OptFunc) Professor
  • func (p Professor) Explain(ctx context.Context, cmd command.Command) (string, error)
• type Source

Variables

var ErrSourceNotSet error = errors.New("source not set")

ErrSourceNotSet thrown when the source is not set.

Types

type OptFunc

type OptFunc func(profe *Professor)

OptFunc used for setting optional configs.

type Professor

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

Professor handles the explanation of commands.

func New

func New(source Source, logger *slog.Logger, opts ...OptFunc) Professor

New returns a new Professor.

func (Professor) Explain

func (p Professor) Explain(ctx context.Context, cmd command.Command) (string, error)

Explain the passed command. If the source is not set, then it will return ErrSourceNotSet.

type Source

type Source interface {
	Prompt(context.Context, string) (string, error)
}

Source is the source of information for the professor.