application

Documentation

Index

• Constants
• func Run[Args any](opt ...Option[Args])
• type API
• type APIFunc
• type Context
  • func (ctx *Context[Args]) Deadline() (deadline time.Time, ok bool)
  • func (ctx *Context[Args]) Done() <-chan struct{}
  • func (ctx *Context[Args]) Err() error
  • func (ctx *Context[Args]) Value(key any) any
• type GoFunc
• type Handler
• type Option
  • func OptionAPI[Args any](api APIFunc[Args]) Option[Args]
  • func OptionApplicationTimeout[Args any](to time.Duration) Option[Args]
  • func OptionGoFunc[Args any](fn GoFunc[Args]) Option[Args]

Constants

const DefaultApplicationTimeout = time.Second * 5

Functions

func Run

func Run[Args any](opt ...Option[Args])

Types

type API

type API = router.API

type APIFunc

type APIFunc[Args any] func(Context[Args]) (API, error)

type Context

type Context[Args any] struct {
	Args struct {
		Args    Args
		Network string `long:"network" description:"network to serve on" default:"tcp" env:"APPLICATION_NETWORK"`
		Address string `long:"address" description:"Address to serve on" default:"0.0.0.0:5443" env:"APPLICATION_ADDRESS"`
	}
	// contains filtered or unexported fields
}

func (*Context[Args]) Deadline

func (ctx *Context[Args]) Deadline() (deadline time.Time, ok bool)

func (*Context[Args]) Done

func (ctx *Context[Args]) Done() <-chan struct{}

func (*Context[Args]) Err

func (ctx *Context[Args]) Err() error

func (*Context[Args]) Value

func (ctx *Context[Args]) Value(key any) any

type GoFunc

type GoFunc[Args any] func(Context[Args]) error

type Handler

type Handler = router.Handler

type Option

type Option[Args any] func(*options[Args])

func OptionAPI

func OptionAPI[Args any](api APIFunc[Args]) Option[Args]

func OptionApplicationTimeout

func OptionApplicationTimeout[Args any](to time.Duration) Option[Args]

func OptionGoFunc

func OptionGoFunc[Args any](fn GoFunc[Args]) Option[Args]