routingcfg

package

v2.0.2 Latest Latest Go to latest Published: Mar 23, 2026 License: AGPL-3.0 Imports: 10 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/verygoodsoftwarenotvirus/platform

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func ProvideRouteParamManager(cfg *Config) (routing.RouteParamManager, error)
func ProvideRouter(cfg *Config, logger logging.Logger, tracerProvider tracing.TracerProvider, ...) (routing.Router, error)
func ProvideRouterViaConfig(cfg *Config, logger logging.Logger, tracerProvider tracing.TracerProvider, ...) (routing.Router, error)
func RegisterRouteParamManager(i do.Injector)
type Config
- func (cfg *Config) ProvideRouter(logger logging.Logger, tracerProvider tracing.TracerProvider, ...) (routing.Router, error)
- func (cfg *Config) ValidateWithContext(ctx context.Context) error

Constants ¶

View Source

const (
	// ProviderChi is the string we use to refer to chi.
	ProviderChi = "chi"
)

Variables ¶

View Source

var (
	// RoutingConfigProviders are what we provide to the dependency injector.
	RoutingConfigProviders = wire.NewSet(

		ProvideRouteParamManager,
	)
)

Functions ¶

func ProvideRouteParamManager ¶

func ProvideRouteParamManager(cfg *Config) (routing.RouteParamManager, error)

ProvideRouteParamManager provides a RouteParamManager from a routing config.

func ProvideRouter ¶

func ProvideRouter(cfg *Config, logger logging.Logger, tracerProvider tracing.TracerProvider, metricProvider metrics.Provider) (routing.Router, error)

ProvideRouter provides a Router from a routing config.

func ProvideRouterViaConfig ¶

func ProvideRouterViaConfig(
	cfg *Config,
	logger logging.Logger,
	tracerProvider tracing.TracerProvider,
	metricProvider metrics.Provider,
) (routing.Router, error)

func RegisterRouteParamManager ¶

func RegisterRouteParamManager(i do.Injector)

RegisterRouteParamManager registers a routing.RouteParamManager with the injector.

Types ¶

type Config ¶

type Config struct {
	Chi      *chi.Config `env:"init"     envPrefix:"CHI_"          json:"chiConfig,omitempty"`
	Provider string      `env:"PROVIDER" json:"provider,omitempty"`
	// contains filtered or unexported fields
}

Config configures our router.

func (*Config) ProvideRouter ¶

func (cfg *Config) ProvideRouter(logger logging.Logger, tracerProvider tracing.TracerProvider, metricProvider metrics.Provider) (routing.Router, error)

ProvideRouter provides a Router from a routing config.

func (*Config) ValidateWithContext ¶

func (cfg *Config) ValidateWithContext(ctx context.Context) error

ValidateWithContext validates a router config struct.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL