slate

README

slate

Opinionated golang application scaffolding

• slate
  • config
    • decoder
      • json
      • yaml
    • source
      • env
      • file
      • dir
      • aggregate
      • rest
  • env
  • fs
  • log
    • formatter
      • json
    • stream
      • console
      • file
  • migration
  • rdb
    • dialect
      • sqlite
      • mysql
  • trigger
  • watchdog
    • formatter
      • def

config

TBD

decoder

TBD

json

TBD

yaml

TBD

source

TBD

env

TBD

file

TBD

dir

TBD

aggregate

TBD

rest

TBD

env

TBD

fs

TBD

log

TBD

formatter

TBD

json

TBD

stream

TBD

console

TBD

file

TBD

migration

TBD

rdb

TBD

dialect

TBD

sqlite

TBD

mysql

TBD

trigger

TBD

watchdog

TBD

formatter

TBD

def

TBD

Documentation

Overview

Package slate implements a service orientated application scaffolding based on Uber dependency injection project and the extensive use of a service container and service registration providers.

Index

• Constants
• Variables
• func NewError(msg string, ctx ...map[string]interface{}) error
• func NewErrorFrom(err error, msg string, ctx ...map[string]interface{}) error
• type Application
  • func NewApplication() *Application
  • func (a *Application) Boot() (e error)
  • func (a *Application) Provide(provider IProvider) error
• type Container
  • func NewContainer() *Container
  • func (c *Container) Clear() error
  • func (c *Container) Close() error
  • func (c *Container) Get(id string) (any, error)
  • func (c *Container) Has(id string) bool
  • func (c *Container) Remove(id string) error
  • func (c *Container) Service(id string, factory interface{}, tags ...string) error
  • func (c *Container) Tag(tag string) ([]any, error)
• type Error
  • func (e *Error) Context() map[string]interface{}
  • func (e *Error) Error() string
  • func (e *Error) Unwrap() error
• type IApplication
• type IContainer
• type IError
• type IProvider

Constants

const (
	// ID defines the slate package container service id base string.
	ID = "slate"

	// EnvID defines the slate package environment variable base name.
	EnvID = "SLATE"
)

Variables

var (
	// ErrNilPointer defines a nil pointer argument error.
	ErrNilPointer = NewError("invalid nil pointer")

	// ErrConversion defines a type conversion error.
	ErrConversion = NewError("invalid type conversion")

	// ErrContainer defines a container error.
	ErrContainer = NewError("service container error")

	// ErrNonFunctionFactory defines a service container registration error
	// that signals that the registration request was made with a
	// non-function service factory.
	ErrNonFunctionFactory = NewError("non-function service factory")

	// ErrFactoryWithoutResult defines a service container registration error
	// that signals that the registration request was made with a
	// function service factory that don't return a service.
	ErrFactoryWithoutResult = NewError("service factory without result")

	// ErrServiceNotFound defines a service not found on the container.
	ErrServiceNotFound = NewError("service not found")
)

Functions

func NewError

func NewError(
	msg string,
	ctx ...map[string]interface{},
) error

NewError will instantiate a new error instance

func NewErrorFrom

func NewErrorFrom(
	err error,
	msg string,
	ctx ...map[string]interface{},
) error

NewErrorFrom create a new contextualized error instance from an existing error

Types

type Application

type Application struct {
	Container
	// contains filtered or unexported fields
}

Application defines the structure that controls the application container and container initialization.

func NewApplication

func NewApplication() *Application

NewApplication used to instantiate a new application.

func (*Application) Boot

func (a *Application) Boot() (e error)

Boot initializes the application if not initialized yet. The initialization of an application is the calling of the register method on all providers, after the registration of all objects in the container, the boot method of all providers will be executed.

func (*Application) Provide

func (a *Application) Provide(
	provider IProvider,
) error

Provide will register a new provider into the application used on the application boot.

type Container

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

Container defines the structure that hold the application service factories and initialized services.

func NewContainer

func NewContainer() *Container

NewContainer used to instantiate a new application service container.

func (*Container) Clear

func (c *Container) Clear() error

Clear will eliminate all the registered object from the container.

func (*Container) Close

func (c *Container) Close() error

Close clean up the container from all the stored objects. If the object has been already instantiated and implements the Closable interface, then the Close method will be called upon the removing instance.

func (*Container) Get

func (c *Container) Get(
	id string,
) (any, error)

Get will retrieve the requested object from the container. If the object has not yet been instantiated, then the factory method will be executed to instantiate it.

func (*Container) Has

func (c *Container) Has(
	id string,
) bool

Has will check if an object is registered with the requested id. This does not mean that is instantiated. The instantiation is just executed when the instance is requested for the first time.

func (*Container) Remove

func (c *Container) Remove(
	id string,
) error

Remove will eliminate the object from the container. If the object has been already instantiated and implements the Closable interface, then the Close method will be called on the removing instance.

func (*Container) Service

func (c *Container) Service(
	id string,
	factory interface{},
	tags ...string,
) error

Service will register a service factory used to return an instance generated by the given factory. This factory method will only be called once, meaning that everytime the service is requested, is always returned the same instance. If any object was registered previously with the requested id, then the object will be removed by calling the Remove method previously the storing of the new object factory.

func (*Container) Tag

func (c *Container) Tag(
	tag string,
) ([]any, error)

Tag will retrieve the list of entries instances that where registered with a tag list containing the request teg.

type Error

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

Error defines a contextualized error

func (*Error) Context

func (e *Error) Context() map[string]interface{}

Context will retrieve the error context information

func (*Error) Error

func (e *Error) Error() string

Error retrieve the error information from the error instance

func (*Error) Unwrap

func (e *Error) Unwrap() error

Unwrap will try to unwrap the error information

type IApplication

type IApplication interface {
	IContainer

	Provide(provider IProvider) error
	Boot() error
}

IApplication defines the interface of a slate application instance that implements a container and handles a series of service providers so the application can properly initialize.

type IContainer

type IContainer interface {
	io.Closer

	Has(id string) bool
	Service(id string, factory interface{}, tags ...string) error
	Get(id string) (any, error)
	Tag(tag string) ([]any, error)
	Remove(id string) error
	Clear() error
}

IContainer defines the interface of a slate application service container instance.

type IError

type IError interface {
	error
	Unwrap() error
	Context() map[string]interface{}
}

IError defines an interface to a contextualized error instance

type IProvider

type IProvider interface {
	Register(container IContainer) error
	Boot(container IContainer) error
}

IProvider is an interface used to define the methods of an object that can be registered into a slate application and register elements in the application container and do some necessary boot actions on initialization.