system

Documentation

Overview

Package system provides system builder which response for properties dependency injection.

The auto configuration composes properties object

Example

This example shows how to use the system build

package main

import ()

func main() {

}

Index

• type App
• type Builder
  • func NewBuilder(configType interface{}, path, name, fileType, profile string) *Builder
  • func (b *Builder) Build(profiles ...string) (interface{}, error)
  • func (b *Builder) BuildWithProfile() (interface{}, error)
  • func (b *Builder) Init() error
  • func (b *Builder) New(name string)
  • func (b *Builder) Read(name string) (interface{}, error)
  • func (b *Builder) Save(p interface{}) error
• type Configuration
• type Env
• type ErrInvalidController
  • func (e *ErrInvalidController) Error() string
• type ErrNotFound
  • func (e *ErrNotFound) Error() string
• type Logging
• type Profiles
• type Server

Examples

• Package

Types

type App

type App struct {
	Project  string   `json:"project" default:"hidevopsio"`
	Name     string   `json:"name" default:"hiboot-app"`
	Profiles Profiles `json:"profiles"`
}

App is the properties of the application, it hold the base info of the application

type Builder

type Builder struct {
	*viper.Viper
	Path       string
	Name       string
	FileType   string
	Profile    string
	ConfigType interface{}
}

Builder is the config file (yaml, json) builder

func NewBuilder

func NewBuilder(configType interface{}, path, name, fileType, profile string) *Builder

func (*Builder) Build

func (b *Builder) Build(profiles ...string) (interface{}, error)

Build config file

func (*Builder) BuildWithProfile

func (b *Builder) BuildWithProfile() (interface{}, error)

BuildWithProfile build config file

func (*Builder) Init

func (b *Builder) Init() error

Init create file if it's not exist

func (*Builder) New

func (b *Builder) New(name string)

New create new viper instance

func (*Builder) Read

func (b *Builder) Read(name string) (interface{}, error)

Read single file

func (*Builder) Save

func (b *Builder) Save(p interface{}) error

Save configurations to file

type Configuration

type Configuration struct {
	App     App     `mapstructure:"app"`
	Server  Server  `mapstructure:"server"`
	Logging Logging `mapstructure:"logging"`
}

Configuration is the system configuration

type Env

type Env struct {
	Name  string
	Value string
}

Env is the name value pair of environment variable

type ErrInvalidController

type ErrInvalidController struct {
	Name string
}

ErrInvalidController invalid controller

func (*ErrInvalidController) Error

func (e *ErrInvalidController) Error() string

type ErrNotFound

type ErrNotFound struct {
	Name string
}

ErrNotFound resource not found error

func (*ErrNotFound) Error

func (e *ErrNotFound) Error() string

type Logging

type Logging struct {
	Level string `json:"level" default:"info"`
}

Logging is the properties of logging

type Profiles

type Profiles struct {
	Include []string `json:"include"`
	Active  string   `json:"active" default:"${APP_PROFILES_ACTIVE:default}"`
}

Profiles is app profiles .include auto configuration starter should be included inside this slide .active active profile

type Server

type Server struct {
	Port string `json:"port" default:"8080"`
}

Server is the properties of http server