requestid

Documentation

Index

• func ConfigAdd(path string)
• func Register(ctx context.Context, mux *c.Mux) (*chi.Config, error)
• type Options
  • func NewOptions() (*Options, error)
  • func NewOptionsWithPath(path string) (opts *Options, err error)
• type RequestID
  • func NewRequestIDWithConfigPath(path string) (*RequestID, error)
  • func NewRequestIDWithOptions(options *Options) *RequestID
  • func (d *RequestID) Register(ctx context.Context, mux *c.Mux) (*chi.Config, error)

Functions

func ConfigAdd

func ConfigAdd(path string)

func Register

func Register(ctx context.Context, mux *c.Mux) (*chi.Config, error)

Register registers requestID middleware for chi.

Types

type Options

type Options struct {
	Enabled bool
}

Options struct which represents requestID plugin from chi options.

func NewOptions

func NewOptions() (*Options, error)

NewOptions returns options from config file or environment vars.

func NewOptionsWithPath

func NewOptionsWithPath(path string) (opts *Options, err error)

NewOptionsWithPath unmarshals a given key path into options and returns it.

type RequestID

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

RequestID struct which represents a requestID middleware for chi.

func NewRequestIDWithConfigPath

func NewRequestIDWithConfigPath(path string) (*RequestID, error)

NewRequestIDWithConfigPath returns a new requestID plugin with options from config path.

func NewRequestIDWithOptions

func NewRequestIDWithOptions(options *Options) *RequestID

NewRequestIDWithOptions returns a new requestID plugin with options.

func (*RequestID) Register

func (d *RequestID) Register(ctx context.Context, mux *c.Mux) (*chi.Config, error)

Register registers this requestID plugin to a new chi config.