models

package

v0.0.0-...-2bd0660 Latest Latest Go to latest Published: Oct 1, 2014 License: MIT Imports: 4 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Package models provides models.

View Source

const (
	EnvDevelopment = "development"
	EnvTest        = "test"
	EnvStaging     = "staging"
	EnvProduction  = "production"
)

Env consts

View Source

var (
	ErrConfigFilePathNotSpecified = errors.New("config file path is not specified")
)

Errors

This section is empty.

type AppConfig struct {
	Env string `yaml:"env"`
}

AppConfig represents a configuration for the application

func (app *AppConfig) Development() bool

Development returns true if the Env == envDevelopment.

func (app *AppConfig) Production() bool

Production returns true if the Env == envProduction.

func (app *AppConfig) Staging() bool

Staging returns true if the Env == envStaging.

func (app *AppConfig) Test() bool

Test returns true if the Env == envTest.

type Config struct {
	App    AppConfig    `yaml:"app"`
	Server ServerConfig `yaml:"server"`
}

Config represents a configuration for Orgs.io.

func NewConfig(flags *Flags) (*Config, error)

NewConfig parses the configuration file, creates and returns a config.

type Flags struct {
	// ConfigFilePath represents a configuration file path.
	ConfigFilePath string
}

Flags presents command line flags.

func NewFlags() (*Flags, error)

NewFlags parses the command-line flags, creates and returns flags.

type ServerConfig struct {
	Port string `yaml:"port"`
	CPUs int    `yaml:"cpus"`
}

ServerConfig represents a configuration for the server.