appflag

Documentation

Overview

Package appflag contains functionality to work with flags.

Index

• type Builder
  • func NewBuilder(appName string, options ...BuilderOption) Builder
• type BuilderOption
  • func BuilderWithTimeout(defaultTimeout time.Duration) BuilderOption
  • func BuilderWithTracing() BuilderOption
• type Container
• type Interceptor

Types

type Builder

type Builder interface {
	BindRoot(flagSet *pflag.FlagSet)
	NewRunFunc(func(context.Context, Container) error, ...Interceptor) func(context.Context, app.Container) error
}

Builder builds run functions.

func NewBuilder

func NewBuilder(appName string, options ...BuilderOption) Builder

NewBuilder returns a new Builder.

type BuilderOption

type BuilderOption func(*builder)

BuilderOption is an option for a new Builder

func BuilderWithTimeout

func BuilderWithTimeout(defaultTimeout time.Duration) BuilderOption

BuilderWithTimeout returns a new BuilderOption that adds a timeout flag and the default timeout.

func BuilderWithTracing

func BuilderWithTracing() BuilderOption

BuilderWithTracing enables zap tracing for the builder.

type Container

type Container interface {
	app.Container
	appname.Container
	applog.Container
	appverbose.Container
}

Container is a container.

type Interceptor

type Interceptor func(func(context.Context, Container) error) func(context.Context, Container) error

Interceptor intercepts and adapts the request or response of run functions.