gocherry

README

gocherry

Documentation

Index

• Variables
• func AppFlags(writer io.Writer) func(*flagset)
• func BuildInfoJson(writer io.Writer)
• func BuildInfoYaml(writer io.Writer)
• func ConfigFlags(writer io.Writer, structs ...any) func(*flagset)
• func FlagConfigGenEnv(structs ...any) func(string) error
• func FlagConfigInfoEnv(writer io.Writer, structs ...any) func(string) error
• func Flags(writer io.Writer, args []string, flagsets ...func(*flagset))
• type App
  • func NewApp(opts ...AppOption) (*App, error)
  • func (app *App) AddServices(services ...any)
  • func (app *App) Start(ctx context.Context) error
  • func (app *App) Stop(ctx context.Context)
• type AppOption
  • func WithHttpRoutes(handler http.Handler) AppOption
  • func WithWorkerPool(subscriptions ...chan PoolTask) AppOption
• type BuildInfo
• type Closer
• type Pool
  • func NewPool(subscriptions ...chan PoolTask) (*Pool, error)
  • func NewPoolContext(ctx context.Context, subscriptions ...chan PoolTask) (*Pool, error)
  • func (p *Pool) Start(ctx context.Context) error
  • func (p *Pool) Stop(ctx context.Context) error
• type PoolTask
• type Service

Variables

var (
	BuildDate string = unset
	GitBranch string = unset
	GitCommit string = unset
	GoVersion string = unset
	GitTag    string = unset
)

Build flags variables

var (
	ErrSuccessExit = errors.New("success and exit with code 0")
)

Functions

func AppFlags

func AppFlags(writer io.Writer) func(*flagset)

func BuildInfoJson

func BuildInfoJson(writer io.Writer)

func BuildInfoYaml

func BuildInfoYaml(writer io.Writer)

func ConfigFlags

func ConfigFlags(writer io.Writer, structs ...any) func(*flagset)

func FlagConfigGenEnv

func FlagConfigGenEnv(structs ...any) func(string) error

func FlagConfigInfoEnv

func FlagConfigInfoEnv(writer io.Writer, structs ...any) func(string) error

func Flags

func Flags(writer io.Writer, args []string, flagsets ...func(*flagset))

Types

type App

type App struct {
	Log *slog.Logger
	// contains filtered or unexported fields
}

func NewApp

func NewApp(opts ...AppOption) (*App, error)

func (*App) AddServices

func (app *App) AddServices(services ...any)

func (*App) Start

func (app *App) Start(ctx context.Context) error

func (*App) Stop

func (app *App) Stop(ctx context.Context)

type AppOption

type AppOption = func(*App)

func WithHttpRoutes

func WithHttpRoutes(handler http.Handler) AppOption

func WithWorkerPool

func WithWorkerPool(subscriptions ...chan PoolTask) AppOption

type BuildInfo

type BuildInfo struct {
	BuildDate string `json:"build_date,omitempty" yaml:"build_date,omitempty"`
	GitBranch string `json:"git_branch,omitempty" yaml:"git_branch,omitempty"`
	GitCommit string `json:"git_commit,omitempty" yaml:"git_commit,omitempty"`
	GoVersion string `json:"go_version,omitempty" yaml:"go_version,omitempty"`
	GitTag    string `json:"git_tag,omitempty" yaml:"git_tag,omitempty"`
}

type Closer

type Closer interface {
	Close(ctx context.Context) error
}

type Pool

type Pool struct {
	// contains filtered or unexported fields
}

func NewPool

func NewPool(subscriptions ...chan PoolTask) (*Pool, error)

func NewPoolContext

func NewPoolContext(ctx context.Context, subscriptions ...chan PoolTask) (*Pool, error)

func (*Pool) Start

func (p *Pool) Start(ctx context.Context) error

func (*Pool) Stop

func (p *Pool) Stop(ctx context.Context) error

type PoolTask

type PoolTask struct {
	ID       string
	Func     func()
	Priority int
}

type Service

type Service interface {
	Start(ctx context.Context) error
	Stop(ctx context.Context) error
}