happy

Jun 3, 2024

Changes in this version

type Settings

+ Config config.Settings

+ Devel devel.Settings

+ Engine engine.Settings

May 24, 2024

Changes in this version

type Settings

+ CLI cli.Settings

+ DateTime datetime.Settings

+ Identifier settings.String

+ Logging logging.Settings

+ Services services.Settings

+ Stats stats.Settings

Mar 31, 2024

Changes in this version

type Main

+ func (m *Main) AddInfo(paragraph string) *Main

Mar 30, 2024

Changes in this version

+ func HasProfile(sess *Session, profile string) (ok bool, dir string)

+ func LoadServices(sess *Session, svcs ...string)

type Command

+ func (c *Command) WithFlags(flagfuncs ...varflag.FlagCreateFunc) *Command

Mar 10, 2024

Changes in this version

+ var ErrCommandHasNoParent = errors.New("command has no parent command")

Mar 3, 2024

Changes in this version

type Settings

+ AsService settings.Bool

Feb 26, 2024

Changes in this version

+ type Brand interface

+ ANSI func() ansicolor.Theme

+ Info func() branding.Info

+ type BrandFunc func() (Brand, error)

type Command

+ func (c *Command) DescribeCategory(cat, desc string)

+ func (c *Command) WithFalgs(flafuncs ...varflag.FlagCreateFunc) *Command

type Main

+ func (m *Main) WithBrand(b BrandFunc) *Main

Feb 21, 2024

Changes in this version

type Service

+ func (s *Service) OnRegister(action Action)

Feb 11, 2024

Changes in this version

type Session

+ func (s *Session) AlowUserCancel()

Feb 5, 2024

Changes in this version

type Main

+ func (m *Main) SetOptions(a ...options.Arg) *Main

type Session

+ func (s *Session) Stats() stats.State

+ func (s *Session) Wait() <-chan struct{}

type Settings

+ StatsEnabled settings.Bool

Feb 1, 2024

Changes in this version

type Settings

+ EngineThrottleTicks settings.Duration

+ func (s *Settings) Migrate(keyfrom, keyto string)

Jan 31, 2024

Changes in this version

+ var ErrSession = fmt.Errorf("%w:session", Error)

+ var Error = errors.New("happy")

+ type ActionWithFlags func(sess *Session, flags Flags) error

+ type ActionWithPrevErr func(sess *Session, err error) error

type Addon

+ func (addon *Addon) ProvidesAPI(api API)

type AddonInfo

+ Module string

type Args

+ Argn func() uint

type Command

+ func (c *Command) AddInfo(paragraph string)

+ type Flags interface

+ Args func() []vars.Value

+ Get func(name string) (varflag.Flag, error)

+ type Main struct

+ func (m *Main) AfterAlways(a ActionWithPrevErr) *Main

+ func (m *Main) AfterFailure(a ActionWithPrevErr) *Main

+ func (m *Main) AfterSuccess(a Action) *Main

+ func (m *Main) Before(a ActionWithArgs) *Main

+ func (m *Main) BeforeAlways(a ActionWithFlags) *Main

+ func (m *Main) Do(a ActionWithArgs) *Main

+ func (m *Main) Run()

+ func (m *Main) Tick(a ActionTick) *Main

+ func (m *Main) Tock(a ActionTock) *Main

+ func (m *Main) WithAddon(addon *Addon) *Main

+ func (m *Main) WithCommand(cmd *Command) *Main

+ func (m *Main) WithFlag(flag varflag.FlagCreateFunc) *Main

+ func (m *Main) WithLogger(l logging.Logger) *Main

+ func (m *Main) WithMigrations(mm *migration.Manager) *Main

+ func (m *Main) WithOptions(opts ...OptionArg) *Main

+ func (m *Main) WithService(svc *Service) *Main

type Options

+ func (opts *Options) Describe(key string) string

type Service

+ func (s *Service) Tick(action ActionTick)

+ func (s *Service) Tock(action ActionTock)

type Session

+ func (s *Session) Describe(key string) string

+ func (s *Session) ServiceLoader(svcs ...string) *ServiceLoader

+ func (s *Session) Setting(key string) settings.Setting

+ func (s *Session) UserClosed() <-chan struct{}

type Settings

+ Instance instance.Settings

+ ServiceLoaderTimeout settings.Duration

Dec 20, 2023

Changes in this version

type Addon

+ func (addon *Addon) Option(key string, value any, description string, validator OptionValueValidator)

type Application

+ func (a *Application) Options(opts ...OptionArg)

type OptionArg

+ func OptionReadonly(key string, value any) OptionArg

type Session

+ func (s *Session) GetSettingVar(key string) settings.Setting

+ func (s *Session) Profile() *settings.Profile

+ type Settings struct

+ CopyrightBy settings.String

+ CopyrightSince settings.Uint

+ Description settings.String

+ I18n i18n.Settings

+ License settings.String

+ Logger logging.Settings

+ MainArgcMax settings.Uint

+ Name settings.String

+ Slug settings.String

+ ThrottleTicks settings.Duration

+ TimeLocation settings.String

+ Usage settings.String

+ func (s *Settings) Extend(group string, ss settings.Settings)

+ func (s Settings) Blueprint() (*settings.Blueprint, error)

Jun 27, 2023

Changes in this version

type Session

+ func (s *Session) Closed() <-chan struct{}

Jun 24, 2023

Changes in this version

type Session

+ func (s *Session) AllowUserCancel()

Jun 18, 2023

Changes in this version

type OptionKind

+ const RuntimeOption

Jun 18, 2023

Changes in this version

type Session

+ func (s *Session) Opts() *vars.Map

May 23, 2023

Changes in this version

type Application

+ func (a *Application) Help(msg string)

type Command

+ func (c *Command) Parents() []string

Apr 25, 2023

Changes in this version

+ var ErrAddon = errors.New("addon error")

+ var ErrApplication = errors.New("application error")

+ var ErrCommand = errors.New("command error")

+ var ErrCommandAction = errors.New("command action error")

+ var ErrCommandFlags = errors.New("command flags error")

+ var ErrEngine = errors.New("engine error")

+ var ErrHappy = errors.New("not so happy")

+ var ErrInvalidVersion = errors.New("invalid version")

+ var ErrOption = errors.New("option error")

+ var ErrOptionReadOnly = fmt.Errorf("%w: readonly option", ErrOption)

+ var ErrOptionValidation = fmt.Errorf("%w: validation failed", ErrOption)

+ var ErrService = errors.New("service error")

+ var ErrSessionDestroyed = errors.New("session destroyed")

+ var OptionValidatorNotEmpty = func(key string, val vars.Value) error

+ func GetAPI(sess *Session, addonName string) (api A, err error)

+ type API interface

+ Get func(key string) vars.Variable

+ Set func(key string, val any) error

+ type Action func(sess *Session) error

+ type ActionMigrate func(ver Version, sess *Session) error

+ type ActionTick func(sess *Session, ts time.Time, delta time.Duration) error

+ type ActionTock func(sess *Session, delta time.Duration, tps int) error

+ type ActionWithArgs func(sess *Session, args Args) error

+ type ActionWithEvent func(sess *Session, ev Event) error

+ type ActionWithOptions func(sess *Session, opts *Options) error

+ type Addon struct

+ API API

+ func NewAddon(name string, opts ...OptionArg) *Addon

+ func (addon *Addon) Emits(scope, key, description string, example *vars.Map)

+ func (addon *Addon) EmitsEvent(event Event)

+ func (addon *Addon) OnRegister(action ActionWithOptions)

+ func (addon *Addon) ProvidesCommand(cmd *Command)

+ func (addon *Addon) ProvidesService(svc *Service)

+ func (addon *Addon) Setting(key string, value any, description string, validator OptionValueValidator)

+ type AddonInfo struct

+ Description string

+ Name string

+ Version version.Version

+ type Application struct

+ func New(opts ...OptionArg) *Application

+ func NewWithLogger(logger L, level LVL, opts ...OptionArg) *Application

+ func (a *Application) AddCommand(cmd *Command)

+ func (a *Application) AddFlag(f varflag.Flag)

+ func (a *Application) AfterAlways(action Action)

+ func (a *Application) AfterFailure(action func(s *Session, err error) error)

+ func (a *Application) AfterSuccess(action Action)

+ func (a *Application) Before(action ActionWithArgs)

+ func (a *Application) Cron(setup func(schedule CronScheduler))

+ func (a *Application) Do(action ActionWithArgs)

+ func (a *Application) Main()

+ func (a *Application) OnInstall(action Action)

+ func (a *Application) OnMigrate(ver string, up, down ActionMigrate)

+ func (a *Application) OnTick(action ActionTick)

+ func (a *Application) OnTock(action ActionTock)

+ func (a *Application) RegisterService(svc *Service)

+ func (a *Application) Setting(key string, value any, description string, validator OptionValueValidator)

+ func (a *Application) WithAddons(addon ...*Addon)

+ type Args interface

+ Arg func(i uint) vars.Value

+ ArgDefault func(i uint, value any) (vars.Value, error)

+ ArgVarDefault func(i uint, key string, value any) (vars.Variable, error)

+ Args func() []vars.Value

+ Flag func(name string) varflag.Flag

+ type Assets interface

+ type Command struct

+ func NewCommand(name string, options ...OptionArg) *Command

+ func (c *Command) AddFlag(f varflag.Flag)

+ func (c *Command) AddSubCommand(cmd *Command)

+ func (c *Command) AfterAlways(action func(s *Session) error)

+ func (c *Command) AfterFailure(action func(s *Session, err error) error)

+ func (c *Command) AfterSuccess(action func(s *Session) error)

+ func (c *Command) Before(action ActionWithArgs)

+ func (c *Command) Description() string

+ func (c *Command) Do(action ActionWithArgs)

+ func (c *Command) Err() error

+ func (c *Command) Name() string

+ func (c *Command) Usage() string

+ type Cron struct

+ func (cs *Cron) Job(expr string, cb Action)

+ func (cs *Cron) Start() error

+ func (cs *Cron) Stop() error

+ type CronScheduler interface

+ Job func(expr string, cb Action)

+ type Engine struct

+ type Event interface

+ Key func() string

+ Payload func() *vars.Map

+ Scope func() string

+ Time func() time.Time

+ func NewEvent(scope, key string, payload *vars.Map, err error) Event

+ func StartServicesEvent(svcs ...string) Event

+ func StopServicesEvent(svcs ...string) Event

+ type EventListener interface

+ OnAnyEvent func(ActionWithEvent)

+ OnEvent func(scope, key string, cb ActionWithEvent)

+ type LogLevel int32

+ const LevelAlways

+ const LevelBUG

+ const LevelDebug

+ const LevelDeprecated

+ const LevelError

+ const LevelInfo

+ const LevelIssue

+ const LevelNotImplemented

+ const LevelNotice

+ const LevelOk

+ const LevelQuiet

+ const LevelSystemDebug

+ const LevelTask

+ const LevelWarn

+ func (l LogLevel) Int() int

+ func (l LogLevel) String() string

+ type LogLevelIface interface

+ Int func() int

+ String func() string

+ type Logger interface

+ Level func() LVL

+ SetLevel func(LVL)

+ type OptionArg struct

+ func Option(key string, value any) OptionArg

+ type OptionKind uint

+ const ConfigOption

+ const ReadOnlyOption

+ const SettingsOption

+ type OptionValueValidator func(key string, val vars.Value) error

+ type Options struct

+ func NewOptions(name string, defaults []OptionArg) (*Options, error)

+ func (opts *Options) Accepts(key string) bool

+ func (opts *Options) Get(key string) vars.Variable

+ func (opts *Options) Has(key string) bool

+ func (opts *Options) Load(key string) (vars.Variable, bool)

+ func (opts *Options) Name() string

+ func (opts *Options) Set(key string, value any) error

+ type Service struct

+ func NewService(name string, opts ...OptionArg) *Service

+ func (s *Service) Cron(setupFunc func(schedule CronScheduler))

+ func (s *Service) OnAnyEvent(cb ActionWithEvent)

+ func (s *Service) OnEvent(scope, key string, cb ActionWithEvent)

+ func (s *Service) OnInitialize(action Action)

+ func (s *Service) OnStart(action Action)

+ func (s *Service) OnStop(action Action)

+ func (s *Service) OnTick(action ActionTick)

+ func (s *Service) OnTock(action ActionTock)

+ type ServiceInfo struct

+ func (s *ServiceInfo) Addr() *address.Address

+ func (s *ServiceInfo) Errs() map[time.Time]error

+ func (s *ServiceInfo) Failed() bool

+ func (s *ServiceInfo) Name() string

+ func (s *ServiceInfo) Running() bool

+ func (s *ServiceInfo) StartedAt() time.Time

+ func (s *ServiceInfo) StoppedAt() time.Time

+ type ServiceLoader struct

+ func NewServiceLoader(sess *Session, svcs ...string) *ServiceLoader

+ func (sl *ServiceLoader) Err() error

+ func (sl *ServiceLoader) Load() <-chan struct{}

+ type Session struct

+ func (s *Session) API(addonName string) (API, error)

+ func (s *Session) Config() *vars.Map

+ func (s *Session) Deadline() (deadline time.Time, ok bool)

+ func (s *Session) Destroy(err error)

+ func (s *Session) Dispatch(ev Event)

+ func (s *Session) Done() <-chan struct{}

+ func (s *Session) Err() error

+ func (s *Session) Get(key string) vars.Variable

+ func (s *Session) Has(key string) bool

+ func (s *Session) Log() *logging.Logger

+ func (s *Session) Ready() <-chan struct{}

+ func (s *Session) RuntimeOpts() *vars.Map

+ func (s *Session) ServiceInfo(svcurl string) (*ServiceInfo, error)

+ func (s *Session) Set(key string, val any) error

+ func (s *Session) Settings() *vars.Map

+ func (s *Session) String() string

+ func (s *Session) Value(key any) any

+ type Version string