router

Documentation

Index

• Constants
• type Client
  • func NewClient(d Dependencies, opts ClientOptions) (Client, error)
• type ClientOption
  • func WithDashboard() ClientOption
  • func WithPathKey(x string) ClientOption
  • func WithRessourceKey(x string) ClientOption
  • func WithSvcKey(x string) ClientOption
• type ClientOptions
  • func ApplyClientOptions(opts *ClientOptions, modifiers ...ClientOption) ClientOptions
• type DefaultTool
  • func NewTool(c Client, opts contract.ToolOptions[Client]) *DefaultTool
  • func (d *DefaultTool) AttachServer(ctx context.Context, s contract.ServerOperator) error
  • func (d *DefaultTool) Mount(ctx context.Context, r []*contract.Route) error
  • func (d *DefaultTool) ParsePath(ctx context.Context, r *http.Request, re *regexp.Regexp) (map[string]string, error)
  • func (d *DefaultTool) ParseQuery(ctx context.Context, r *http.Request) (map[string][]string, error)
  • func (d *DefaultTool) RKey(ctx context.Context) (string, error)
  • func (d *DefaultTool) Run(ctx context.Context) error
  • func (d *DefaultTool) Stop(ctx context.Context) error
  • func (d *DefaultTool) SvcKey(ctx context.Context) (string, error)
  • func (d *DefaultTool) Vars(ctx context.Context) (*config.Vars, error)
• type Dependencies
• type Pattern
• type Tool

Constants

const (
	// PatID matches numeric path parameters (e.g., user ID).
	PatID Pattern = `[0-9]+`
	// PatName matches alphabetic characters only (uppercase or lowercase).
	PatName Pattern = `[a-zA-Z]+`
	// PatWord matches any word-like token (alphanumeric and underscore).
	PatWord Pattern = `\w+`
	// PatWordCI matches word-like tokens, case-insensitive.
	PatWordCI Pattern = `(?i)\w+`
	// PatEmail matches a basic email address format.
	PatEmail Pattern = `[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}`
	// PatOID matches a 24-character hexadecimal string (MongoDB ObjectID).
	PatOID Pattern = `[0-9a-fA-F]{24}`
	// PatFile matches any file name with an extension.
	PatFile Pattern = `.*\.[^/]*$`
	// PatUUID matches a UUID string in standard 8-4-4-4-12 format.
	PatUUID Pattern = `[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}`
	// PKey is the default key for path parameters.
	PKey = "_p"
	// RKey is the default ressource key.
	RKey = "_r"
	// SvcKey is the default service key.
	SvcKey = "_s"
	// PathActions is the default path for actions.
	PathActions = "actions"
)

Types

type Client

type Client interface {
	contract.RouterOperator
}

func NewClient

func NewClient(d Dependencies, opts ClientOptions) (Client, error)

type ClientOption

type ClientOption func(*ClientOptions)

func WithDashboard

func WithDashboard() ClientOption

func WithPathKey

func WithPathKey(x string) ClientOption

func WithRessourceKey

func WithRessourceKey(x string) ClientOption

func WithSvcKey

func WithSvcKey(x string) ClientOption

type ClientOptions

type ClientOptions struct {
	Dashboard    bool
	SvcKey       string
	RessourceKey string
	PathKey      string
}

func ApplyClientOptions

func ApplyClientOptions(opts *ClientOptions, modifiers ...ClientOption) ClientOptions

type DefaultTool

type DefaultTool struct {
	T *contract.Tool[Client]
}

func NewTool

func NewTool(c Client, opts contract.ToolOptions[Client]) *DefaultTool

func (*DefaultTool) AttachServer

func (d *DefaultTool) AttachServer(ctx context.Context, s contract.ServerOperator) error

AttachServer attaches the server operator to the router.

func (*DefaultTool) Mount

func (d *DefaultTool) Mount(ctx context.Context, r []*contract.Route) error

Mount mounts the routes to the router.

func (*DefaultTool) ParsePath

func (d *DefaultTool) ParsePath(ctx context.Context, r *http.Request, re *regexp.Regexp) (map[string]string, error)

ParsePath extracts path parameters using the route regex.

func (*DefaultTool) ParseQuery

func (d *DefaultTool) ParseQuery(ctx context.Context, r *http.Request) (map[string][]string, error)

ParseQuery returns query parameters from the request.

func (*DefaultTool) RKey

func (d *DefaultTool) RKey(ctx context.Context) (string, error)

RKey returns the ressource key configured for the router.

func (*DefaultTool) Run

func (d *DefaultTool) Run(ctx context.Context) error

Run starts the router server.

func (*DefaultTool) Stop

func (d *DefaultTool) Stop(ctx context.Context) error

Stop gracefully shuts down the router server.

func (*DefaultTool) SvcKey

func (d *DefaultTool) SvcKey(ctx context.Context) (string, error)

SvcKey returns the service key configured for the router.

func (*DefaultTool) Vars

func (d *DefaultTool) Vars(ctx context.Context) (*config.Vars, error)

Vars extracts routing variables from context.

type Dependencies

type Dependencies struct {
	RM *contract.RegistryMutex
	R  contract.Registry
	L  contract.LimiterOperator
	SM contract.SemaphoreOperator
	S  contract.ServerOperator
}

type Pattern

type Pattern = string

Pattern represents a regex pattern string.

type Tool

type Tool interface {
	Client
}