realip

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 RealIP
  • func NewRealIPWithConfigPath(path string) (*RealIP, error)
  • func NewRealIPWithOptions(options *Options) *RealIP
  • func (d *RealIP) 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 realIP middleware for chi.

Types

type Options

type Options struct {
	Enabled bool
}

Options struct which represents realIp 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 RealIP

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

RealIP struct which represents a realIP plugin

func NewRealIPWithConfigPath

func NewRealIPWithConfigPath(path string) (*RealIP, error)

NewRealIPWithConfigPath returns realIP plugin with options from config path.

func NewRealIPWithOptions

func NewRealIPWithOptions(options *Options) *RealIP

NewRealIPWithOptions returns realIP plugin with options.

func (*RealIP) Register

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

Register registers the realIP plugin on a new chi config.