config

package

v0.0.0-...-431252f Latest Latest Go to latest Published: Apr 11, 2022 License: BSL-1.0 Imports: 6 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

Repository

github.com/illiafox/mailbase

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func FlagString(format *Format) func(string) error
type Config
- func ReadConfig(filename string, format Format) (Config, error)
type Email
type Format
type Host
type MySQL
type Redis

Constants ¶

View Source

const (

	// JSON https://pkg.go.dev/encoding/json
	JSON

	// TOML https://pkg.go.dev/github.com/pelletier/go-toml
	TOML

	// YAML https://pkg.go.dev/gopkg.in/yaml.v3
	YAML
)

Variables ¶

View Source

var Available = func() string {
	ret := make([]string, len(FormatMap))
	i := 0
	for k := range FormatMap {
		ret[i] = k
		i++
	}
	return strings.Join(ret, " ")
}()

Available is string implementation of all formats. Can be used with flag package Example:

'json toml yaml'

View Source

var FormatMap = map[string]Format{
	"json": JSON,
	"toml": TOML,
	"yaml": YAML,
}

FormatMap is a map implementation of all formats Can be used with flag package

Functions ¶

func FlagString ¶

func FlagString(format *Format) func(string) error

Types ¶

type Config ¶

type Config struct {
	MySQL MySQL
	Redis Redis
	Host  Host
	SMTP  Email
}

func ReadConfig ¶

func ReadConfig(filename string, format Format) (Config, error)

ReadConfig reads and parses config using available formats (JSON, TOML, YAML) Example:

config.ReadConfig("config.json",config.JSON)

type Email ¶

type Email struct {
	Mail     string
	Password string
	Hostname string
	Port     int
}

type Format ¶

type Format int

type Host ¶

type Host struct {
	Port string
	HTTP bool   // Start server in http mode
	Key  string // Path to TLS key
	Cert string // Path to TLS key
}

type MySQL ¶

type MySQL struct {
	Login    string
	Pass     string
	DbName   string // 'mysql'
	IP       string
	Port     string
	Protocol string
}

type Redis ¶

type Redis struct {
	Addr string
	Pass string // Optional
	DB   int
}

Source Files ¶

View all Source files

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