rule

Documentation

Index

• Constants
• Variables
• func NewAppendPath(begin, end string) struct{ ... }
• func NewRateLimiter(requestLimit int, windowDuration time.Duration) struct{ ... }
• func NewReplacePath(search string, replace string, times int) struct{ ... }
• type AppendPath
  • func (a *AppendPath) IsCachable() bool
  • func (a *AppendPath) Process(next http.Handler) http.Handler
  • func (a *AppendPath) UpdateMiddelware(newImpl Middleware) Middleware
• type BuilderFunc
• type Middleware
• type RateLimiter
  • func (r *RateLimiter) IsCachable() bool
  • func (r *RateLimiter) Process(next http.Handler) http.Handler
  • func (r *RateLimiter) UpdateMiddelware(newImpl Middleware) Middleware
• type RegisterFunc
  • func RegisterAppendPath() RegisterFunc
  • func RegisterRateLimiter() RegisterFunc
  • func RegisterReplacePath() RegisterFunc
• type ReplacePath
  • func (p *ReplacePath) IsCachable() bool
  • func (p *ReplacePath) Process(next http.Handler) http.Handler
  • func (p *ReplacePath) UpdateMiddelware(newImpl Middleware) Middleware
• type WindowDuration
  • func (d WindowDuration) MarshalJSON() ([]byte, error)
  • func (d *WindowDuration) UnmarshalJSON(data []byte) error

Constants

const AppendPathName = "AppendPath"

const ReplacePathName = "ReplacePath"

Variables

var Empty = []Middleware{}

Functions

func NewAppendPath

func NewAppendPath(begin, end string) struct {
	Type string `json:"type"`
	Args any    `json:"args"`
}

func NewRateLimiter

func NewRateLimiter(requestLimit int, windowDuration time.Duration) struct {
	Type string `json:"type"`
	Args any    `json:"args"`
}

func NewReplacePath

func NewReplacePath(search string, replace string, times int) struct {
	Type string `json:"type"`
	Args any    `json:"args"`
}

Types

type AppendPath

type AppendPath struct {
	Begin string `json:"begin"`
	End   string `json:"end"`
}

func (*AppendPath) IsCachable

func (a *AppendPath) IsCachable() bool

func (*AppendPath) Process

func (a *AppendPath) Process(next http.Handler) http.Handler

func (*AppendPath) UpdateMiddelware

func (a *AppendPath) UpdateMiddelware(newImpl Middleware) Middleware

type BuilderFunc

type BuilderFunc func(raw json.RawMessage) (Middleware, error)

type Middleware

type Middleware interface {
	Process(next http.Handler) http.Handler
	IsCachable() bool
	UpdateMiddelware(newImpl Middleware) Middleware
}

type RateLimiter

type RateLimiter struct {
	RequestLimit   int            `json:"request_limit"`
	WindowDuration WindowDuration `json:"window_duration"`
	// contains filtered or unexported fields
}

func (*RateLimiter) IsCachable

func (r *RateLimiter) IsCachable() bool

func (*RateLimiter) Process

func (r *RateLimiter) Process(next http.Handler) http.Handler

func (*RateLimiter) UpdateMiddelware

func (r *RateLimiter) UpdateMiddelware(newImpl Middleware) Middleware

type RegisterFunc

type RegisterFunc func(map[string]BuilderFunc) error

func RegisterAppendPath

func RegisterAppendPath() RegisterFunc

func RegisterRateLimiter

func RegisterRateLimiter() RegisterFunc

func RegisterReplacePath

func RegisterReplacePath() RegisterFunc

type ReplacePath

type ReplacePath struct {
	Search  string `json:"search"`
	Replace string `json:"replace"`
	Times   int    `json:"times"`
}

func (*ReplacePath) IsCachable

func (p *ReplacePath) IsCachable() bool

func (*ReplacePath) Process

func (p *ReplacePath) Process(next http.Handler) http.Handler

func (*ReplacePath) UpdateMiddelware

func (p *ReplacePath) UpdateMiddelware(newImpl Middleware) Middleware

type WindowDuration

type WindowDuration struct {
	time.Duration
}

func (WindowDuration) MarshalJSON

func (d WindowDuration) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for WindowDuration.

func (*WindowDuration) UnmarshalJSON

func (d *WindowDuration) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for WindowDuration.