happy

package module

Go to main page

Versions in this module

v0

v0.2.4

Feb 3, 2023

Changes in this version

type Session

+ func (s *Session) X() bool

v0.2.3

Feb 2, 2023

v0.2.2

Feb 2, 2023

v0.2.1

Feb 2, 2023

v0.2.0

Feb 2, 2023

Changes in this version

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

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

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

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

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

type Addon

+ 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 Application

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

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

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

+ type Level int8

+ type LogLevel int

+ const LogLevelAlert

+ const LogLevelAlways

+ const LogLevelBUG

+ const LogLevelCritical

+ const LogLevelDebug

+ const LogLevelDeprecated

+ const LogLevelEmergency

+ const LogLevelError

+ const LogLevelInfo

+ const LogLevelIssue

+ const LogLevelNotImplemented

+ const LogLevelNotice

+ const LogLevelOk

+ const LogLevelSystemDebug

+ const LogLevelTask

+ const LogLevelWarn

+ type OptionArg struct

type OptionKind

+ const ConfigOption

+ const ReadOnlyOption

+ const SettingsOption

type Session

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

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

v0.1.5

Jan 13, 2023

Changes in this version

+ const LevelDebug

+ const LevelDeprecated

+ const LevelError

+ const LevelInfo

+ const LevelIssue

+ const LevelNotImplemented

+ const LevelNotice

+ const LevelOk

+ const LevelOut

+ const LevelSystemDebug

+ const LevelTask

+ const LevelWarn

+ 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 ErrOption = errors.New("option error")

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

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

+ var ErrOptions = errors.New("options error")

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

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

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

type API

+ Get func(key string) vars.Variable

+ Set func(key string, value any)

+ type Action func(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 Addon

+ Events func() []Event

+ Register func(*Session) (AddonInfo, error)

type AddonInfo

+ Description string

type Application

+ func New(opts ...OptionAttr) *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) OnTick(action ActionTick)

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

+ 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

+ func NewCommand(name string, options ...OptionAttr) *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) Do(action ActionWithArgs)

+ func (c *Command) Name() string

+ func (c *Command) Usage() string

type Cron

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

+ func (cs *Cron) Start() error

+ func (cs *Cron) Stop() error

type Event

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

+ func RegisterEvent(scope, key, desc string, example *vars.Map) Event

+ func StartServicesEvent(svcs ...string) Event

+ func StopServicesEvent(svcs ...string) Event

+ type OptionAttr struct

+ func Option(key string, value any) OptionAttr

+ type OptionKind uint

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

type Options

+ func NewOptions(name string, defaults []OptionAttr) (*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

+ func NewService(name string, opts ...OptionAttr) *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) 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

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

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

type Session

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

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

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

+ func (s *Session) Err() error

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

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

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

+ func (s *Session) String() string

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

v0.1.4

Dec 15, 2022

Changes in this version

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

type Version

+ func ParseVersion(v string) (Version, error)

+ func (v *Version) UnmarshalJSON(data []byte) error

+ func (v Version) IsZero() bool

+ func (v Version) MarshalJSON() ([]byte, error)

+ func (v Version) String() string

v0.1.3

Dec 13, 2022

v0.1.2

Dec 13, 2022

v0.1.1

Dec 13, 2022

Changes in this version

+ var ApplicationVersion string

v0.1.0

Oct 20, 2022

Changes in this version

+ type API interface

+ type ActionCommandFunc func(sess Session, flags Flags, assets FS, status ApplicationStatus, apis []API) error

+ type ActionCronFunc func(sess Session) error

+ type ActionCronSchedulerSetup func(CronScheduler)

+ type ActionFunc func(sess Session) error

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

+ type ActionWithArgsFunc func(sess Session, args Variables) error

+ type ActionWithErrorFunc func(sess Session, err Error) error

+ type ActionWithEventFunc func(sess Session, ev Event) error

+ type ActionWithStatusFunc func(sess Session, status ApplicationStatus) error

+ type Addon interface

+ API func() API

+ Commands func() []Command

+ Cronjobs func()

+ Name func() string

+ Services func() []Service

+ Slug func() Slug

+ Version func() Version

+ type AddonCreateFunc func() (Addon, Error)

+ type AddonInfo struct

+ Name string

+ Slug Slug

+ Version Version

+ type Application interface

+ Configure func(Configurator) Error

+ Exit func(code int)

+ Log func() Logger

+ Main func()

+ RegisterAddon func(Addon)

+ RegisterAddons func(...AddonCreateFunc)

+ RegisterService func(Service)

+ RegisterServices func(...ServiceCreateFunc)

+ Version func() Version

+ type ApplicationStatus interface

+ Addons func() []AddonInfo

+ DebugInfo func() Variables

+ Dependencies func() []DependencyInfo

+ Elapsed func() time.Duration

+ GetServiceStatus func(url URL) (ServiceStatus, Error)

+ Services func() []ServiceStatus

+ Started func() time.Time

+ TotalEvents func() int

+ type BackgroundService interface

+ HandleEvent func(sess Session, ev Event) error

+ Initialize func(Session, ApplicationStatus) Error

+ Start func(sess Session, args Variables) Error

+ Stop func(Session) Error

+ Tick func(sess Session, ts time.Time, delta time.Duration) Error

+ Tock func(sess Session, ts time.Time, delta time.Duration) Error

+ type Command interface

+ AttachParent func(parent Command)

+ Category func() string

+ Description func() string

+ Err func() Error

+ ExecuteAfterAlwaysAction func(sess Session, err Error) Error

+ ExecuteAfterFailureAction func(sess Session, err Error) Error

+ ExecuteAfterSuccessAction func(sess Session) Error

+ ExecuteBeforeAction func(sess Session, assets FS, status ApplicationStatus, apis []API) Error

+ ExecuteDoAction func(sess Session, assets FS, status ApplicationStatus, apis []API) Error

+ Flag func(name string) Flag

+ Flags func() Flags

+ HasSubcommands func() bool

+ Parent func() Command

+ Parents func() (parents []string)

+ SetParents func(parents []string)

+ Slug func() Slug

+ SubCommand func(name string) (cmd Command, exists bool)

+ SubCommands func() []Command

+ UsageDescription func() string

+ Verify func() Error

+ WithServices func(urls ...URL)

+ type CommandActionSetter interface

+ AfterAlways func(action ActionWithErrorFunc)

+ AfterFailure func(action ActionWithErrorFunc)

+ AfterSuccess func(action ActionFunc)

+ Before func(ActionCommandFunc)

+ Do func(ActionCommandFunc)

+ type CommandCreateFunc func() (Command, Error)

+ type CommandFlagSetter interface

+ AddFlag func(Flag)

+ AddFlags func(flags ...FlagCreateFunc)

+ type CommandSubCommandSetter interface

+ AddSubCommand func(Command)

+ AddSubCommands func(...CommandCreateFunc)

+ type Configurator interface

+ GetApplicationOptions func() Variables

+ GetAssets func() (FS, Error)

+ GetEngine func() (Engine, Error)

+ GetLogger func() (Logger, Error)

+ GetMonitor func() (Monitor, Error)

+ GetSession func() (Session, Error)

+ UseAssets func(FS)

+ UseEngine func(Engine)

+ UseLogger func(Logger)

+ UseMonitor func(Monitor)

+ UseSession func(Session)

+ type Cron interface

+ Cron func(ActionCronSchedulerSetup)

+ type CronHandler interface

+ Expr func() string

+ Job func() ActionWithErrorFunc

+ type CronScheduler interface

+ Job func(expr string, cb ActionCronFunc)

+ type DependencyInfo struct

+ Path string

+ Sum string

+ Version string

+ type Engine interface

+ AttachMonitor func(monitor Monitor) Error

+ ListenEvents func(<-chan Event)

+ Monitor func() Monitor

+ Register func(...Service) Error

+ Start func(Session) Error

+ Stop func(Session) Error

+ type Error interface

+ Code func() int

+ Error func() string

+ WithText func(string) Error

+ WithTextf func(template string, args ...any) Error

+ Wrap func(error) Error

+ type Event interface

+ Err func() Error

+ Key func() string

+ Payload func() Variables

+ Scope func() string

+ Time func() time.Time

+ type EventListener interface

+ OnAnyEvent func(ActionWithEventFunc)

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

+ type FS interface

+ ReadDir func(name string) ([]fs.DirEntry, error)

+ ReadFile func(name string) ([]byte, error)

+ type Flag interface

+ Aliases func() []string

+ AttachTo func(cmdname string)

+ BelongsTo func() string

+ Default func() Variable

+ Flag func() string

+ Global func() bool

+ Hidden func() bool

+ Hide func()

+ Input func() []string

+ MarkAsRequired func()

+ Name func() string

+ Parse func([]string) (bool, error)

+ Pos func() int

+ Present func() bool

+ Required func() bool

+ String func() string

+ Unset func()

+ Usage func() string

+ UsageAliases func() string

+ Var func() Variable

+ type FlagCreateFunc func() (Flag, Error)

+ type Flags interface

+ AcceptsArgs func() bool

+ Add func(...Flag) error

+ AddSet func(...Flags) error

+ Args func() []Value

+ Flags func() []Flag

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

+ GetActiveSets func() []Flags

+ Len func() int

+ Name func() string

+ Parse func(args []string) error

+ Pos func() int

+ Present func() bool

+ Sets func() []Flags

+ type LogEntry struct

+ Label string

+ Message string

+ Priority LogPriority

+ Time time.Time

+ type LogPriority int

+ const LOG_ALERT

+ const LOG_CRIT

+ const LOG_DEBUG

+ const LOG_EMERG

+ const LOG_ERR

+ const LOG_INFO

+ const LOG_NOTICE

+ const LOG_SYSTEMDEBUG

+ const LOG_WARNING

+ type Logger interface

+ Alert func(args ...any)

+ Alertf func(template string, args ...any)

+ BUG func(args ...any)

+ BUGF func(template string, args ...any)

+ Critical func(args ...any)

+ Criticalf func(template string, args ...any)

+ Debug func(args ...any)

+ Debugf func(template string, args ...any)

+ Deprecated func(args ...any)

+ Deprecatedf func(template string, args ...any)

+ Emergency func(args ...any)

+ Emergencyf func(template string, args ...any)

+ Error func(args ...any)

+ Errorf func(template string, args ...any)

+ Experimental func(args ...any)

+ Experimentalf func(template string, args ...any)

+ GetPriority func() LogPriority

+ Info func(args ...any)

+ Infof func(template string, args ...any)

+ LogInitialization func()

+ NotImplemented func(args ...any)

+ NotImplementedf func(template string, args ...any)

+ Notice func(args ...any)

+ Noticef func(template string, args ...any)

+ Ok func(args ...any)

+ Okf func(template string, args ...any)

+ OnEntry func(func(LogEntry))

+ Output func(calldepth int, s string) error

+ Print func(v ...any)

+ Printf func(format string, v ...any)

+ Println func(v ...any)

+ ResetPriority func()

+ SetOutput func(w io.Writer)

+ SetPriority func(LogPriority)

+ SetRuntimePriority func(LogPriority)

+ SystemDebug func(args ...any)

+ SystemDebugf func(template string, args ...any)

+ Warn func(args ...any)

+ Warnf func(template string, args ...any)

+ Writer func() io.Writer

+ type Monitor interface

+ RegisterAddon func(AddonInfo)

+ SetServiceStatus func(url, key string, val any)

+ Start func(Session) Error

+ Status func() ApplicationStatus

+ Stop func() Error

+ type OptionDefaultsSetter interface

+ SetOptionDefault func(Variable) Error

+ SetOptionDefaultKeyValue func(key string, val any) Error

+ SetOptionsDefaultFuncs func(vfuncs ...VariableParseFunc) Error

+ type OptionGetter interface

+ GetOption func(key string) (Variable, Error)

+ GetOptionOrDefault func(key string, defval any) (val Variable)

+ GetOptionSetFunc func(srcKey, destKey string) OptionSetFunc

+ GetOptions func() Variables

+ HasOption func(key string) bool

+ RangeOptions func(f func(opt Variable) bool)

+ type OptionSetFunc func(opts OptionSetter) Error

+ type OptionSetter interface

+ SetOption func(Variable) Error

+ SetOptionKeyValue func(key string, val any) Error

+ SetOptionValue func(key string, val Value) Error

+ type Options interface

+ DeleteOption func(key string) Error

+ ResetOptions func() Error

+ type Service interface

+ Name func() string

+ OnInitialize func(ActionWithStatusFunc)

+ OnRequest func(r ServiceRouter)

+ OnStart func(ActionWithArgsFunc)

+ OnStop func(ActionFunc)

+ Register func(Session) (BackgroundService, Error)

+ Slug func() Slug

+ URL func() URL

+ type ServiceCreateFunc func() (Service, Error)

+ type ServiceHandler func(sess Session, req ServiceRequest) ServiceResponse

+ type ServiceLoader interface

+ Err func() Error

+ Loaded func() <-chan struct{}

+ type ServiceRequest interface

+ Payload func() any

+ URL func() URL

+ type ServiceResponse interface

+ Duration func() time.Duration

+ Payload func() any

+ type ServiceRouter interface

+ Handle func(path string, handler ServiceHandler)

+ type ServiceStatus struct

+ Err string

+ Failed bool

+ Registered bool

+ Running bool

+ StartedAt time.Time

+ StoppedAt time.Time

+ URL string

+ type Session interface

+ Context func() context.Context

+ Destroy func(err Error)

+ Dispatch func(Event)

+ Events func() <-chan Event

+ Get func(key string) Variable

+ Log func() Logger

+ Opts func() Variables

+ Ready func() <-chan struct{}

+ RequireServices func(status ApplicationStatus, urls ...string) ServiceLoader

+ Settings func() Settings

+ Start func() Error

+ Store func(key string, value any)

+ type Settings interface

+ Save func() Error

+ type Slug interface

+ Valid func() bool

+ type TickerFuncs interface

+ OnTick func(ActionTickFunc)

+ OnTock func(ActionTickFunc)

+ type URL interface

+ Args func() Variables

+ PeerService func() string

+ type Value interface

+ Bool func() (bool, error)

+ Complex128 func() (complex128, error)

+ Complex64 func() (complex64, error)

+ Fields func() []string

+ Float32 func() (float32, error)

+ Float64 func() (float64, error)

+ Int func() (int, error)

+ Int16 func() (int16, error)

+ Int32 func() (int32, error)

+ Int64 func() (int64, error)

+ Int8 func() (int8, error)

+ Len func() int

+ String func() string

+ Uint func() (uint, error)

+ Uint16 func() (uint16, error)

+ Uint32 func() (uint32, error)

+ Uint64 func() (uint64, error)

+ Uint8 func() (uint8, error)

+ Uintptr func() (uintptr, error)

+ Underlying func() any

+ type ValueKind uint

+ const KindArray

+ const KindBool

+ const KindChan

+ const KindComplex128

+ const KindComplex64

+ const KindFloat32

+ const KindFloat64

+ const KindFunc

+ const KindInt

+ const KindInt16

+ const KindInt32

+ const KindInt64

+ const KindInt8

+ const KindInterface

+ const KindInvalid

+ const KindMap

+ const KindPointer

+ const KindSlice

+ const KindString

+ const KindStruct

+ const KindUint

+ const KindUint16

+ const KindUint32

+ const KindUint64

+ const KindUint8

+ const KindUintptr

+ const KindUnsafePointer

+ type ValueParseFunc func() (Value, Error)

+ type Variable interface

+ Bool func() bool

+ Complex128 func() complex128

+ Complex64 func() complex64

+ Fields func() []string

+ Float32 func() float32

+ Float64 func() float64

+ Int func() int

+ Int16 func() int16

+ Int32 func() int32

+ Int64 func() int64

+ Int8 func() int8

+ Key func() string

+ Len func() int

+ ReadOnly func() bool

+ String func() string

+ Uint func() uint

+ Uint16 func() uint16

+ Uint32 func() uint32

+ Uint64 func() uint64

+ Uint8 func() uint8

+ Uintptr func() uintptr

+ Underlying func() any

+ Value func() Value

+ type VariableParseFunc func() (Variable, Error)

+ type Variables interface

+ All func() []Variable

+ Delete func(key string)

+ ExtractWithPrefix func(prfx string) Variables

+ Get func(key string) (v Variable)

+ Has func(key string) bool

+ Len func() int

+ Load func(key string) (v Variable, ok bool)

+ LoadAndDelete func(key string) (v Variable, loaded bool)

+ LoadOrDefault func(key string, value any) (v Variable, loaded bool)

+ LoadOrStore func(key string, value any) (actual Variable, loaded bool)

+ LoadWithPrefix func(prfx string) (Variables, bool)

+ Range func(f func(v Variable) bool)

+ Store func(key string, value any)

+ type Version interface

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