handler

Documentation

Index

• Variables
• type Handler
  • func New(opt ...Option) *Handler
  • func (h *Handler) GetImportRules() error
  • func (h *Handler) ReloadRules(w http.ResponseWriter, r *http.Request)
  • func (h *Handler) VanityServer(w http.ResponseWriter, r *http.Request)
• type Option
  • func WithConfigFile(configFile string) Option
  • func WithGodocURL(godocURL string) Option
• type Options
  • func NewOptions(options ...Option) Options
• type Rules

Variables

var (
	ErrReadConfigFile  = fmt.Errorf("failed to read rules config file")
	ErrParseConfigFile = fmt.Errorf("failed to parse rules config file")
)

custom errors.

Types

type Handler

type Handler struct {
	sync.Mutex
	// contains filtered or unexported fields
}

Handler struct.

func New

func New(opt ...Option) *Handler

New handler struct.

func (*Handler) GetImportRules

func (h *Handler) GetImportRules() error

GetImportRules loads config file (import path mapping rules)

func (*Handler) ReloadRules

func (h *Handler) ReloadRules(w http.ResponseWriter, r *http.Request)

ReloadRules is the handler that reloads mapping rules from config.

func (*Handler) VanityServer

func (h *Handler) VanityServer(w http.ResponseWriter, r *http.Request)

VanityServer redirects browsers to godoc or go tool to VCS repository.

type Option

type Option func(*Options)

Option type

func WithConfigFile

func WithConfigFile(configFile string) Option

WithConfigFile sets the config file path.

func WithGodocURL

func WithGodocURL(godocURL string) Option

WithGodocURL sets the redirect URL for godoc.

type Options

type Options struct {
	ConfigFile   string
	GodocURL     string
	MappingRules []Rules
}

Options struct

func NewOptions

func NewOptions(options ...Option) Options

NewOptions returns a new set of options for the http handler.

type Rules

type Rules struct {
	ImportRoot string `json:"importroot"`
	VCS        string `json:"vcs"`
	RepoRoot   string `json:"reporoot"`
}

Rules for mapping go-import.