cfg

package
v0.0.0-...-381b1be Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 21, 2024 License: MIT Imports: 18 Imported by: 0

README

cfg

-- import "github.com/dockerian/go-coding/pkg/cfg"

Package cfg :: aws.go - extended AWS SDK functions

Package cfg :: config.go Get project settings from os env or specified config.yaml

Package cfg :: context.go

Package cfg :: env.go

Usage

func Decrypt
func Decrypt(text string) string

Decrypt tries to decrypt a text

func DecryptKeyTextByKMS
func DecryptKeyTextByKMS(key, text string) string

DecryptKeyTextByKMS checks possible encrypted KMS key/value and retruns decrypted text

func Flatten
func Flatten(prefix string, value interface{}, kvmap map[string]string)

Flatten builds a flattened key/value string pairs map

func FlattenConfig
func FlattenConfig(file string) map[string]string

FlattenConfig loads a config file (.yaml) to flattened key/value map

type Config
type Config struct {
}

Config represents a flattened settings per config file

func GetConfig
func GetConfig(file string) *Config

GetConfig gets a singleton instance of Config

func (Config) Get
func (c Config) Get(key string, defaultValues ...string) string

Get gets string value of the key in os.Environ() or Config.settings or using defaultValues[0] if provided; otherwise return ""

func (Config) GetBool
func (c Config) GetBool(key string, defaultValues ...bool) bool

GetBool gets boolean value of the key, or defaultValues[0], or false

func (Config) GetInt32
func (c Config) GetInt32(key string, defaultValues ...int32) int32

GetInt32 gets int32 value of the key, or defaultValues[0], or 0

func (Config) GetInt64
func (c Config) GetInt64(key string, defaultValues ...int64) int64

GetInt64 gets int64 value of the key, or defaultValues[0], or 0

func (Config) GetUint32
func (c Config) GetUint32(key string, defaultValues ...uint32) uint32

GetUint32 gets uint32 value of the key, or defaultValues[0], or 0

func (Config) GetUint64
func (c Config) GetUint64(key string, defaultValues ...uint64) uint64

GetUint64 gets uint64 value of the key, or defaultValues[0], or 0

type ConfigParserFunc
type ConfigParserFunc func([]byte, interface{}) error

ConfigParserFunc is a generic parser function

type ConfigReaderFunc
type ConfigReaderFunc func(string) ([]byte, error)

ConfigReaderFunc is a generic reader function

type Context
type Context struct {
	context.Context
	Cookie  *http.Cookie
	Session *sessions.Session
	Env     *Env
}

Context struct wraps Env, http.Cookie, gorilla Session, and Context

func (*Context) Value
func (ctx *Context) Value(key interface{}) interface{}

Value implements context.Context

type DecryptFunc
type DecryptFunc func(string, string) string

DecryptFunc is a generic decrypt function

type Env
type Env map[string]interface{}

Env struct stores application-wide configuration

func (Env) Delete
func (env Env) Delete(key string)

Delete removes a key and the mapping value

func (Env) Get
func (env Env) Get(key string) string

Get returns string for the mapping value by the key

func (Env) GetInt
func (env Env) GetInt(key string) int

GetInt returns int for the mapping value by the key

func (Env) GetValue
func (env Env) GetValue(key string) interface{}

GetValue returns the mapping value by the key

func (Env) Set
func (env Env) Set(key string, value interface{})

Set overwrite the mapping value by the key

type KMSDecryptInterface
type KMSDecryptInterface interface {
	Decrypt(input *kms.DecryptInput) (*kms.DecryptOutput, error)
}

KMSDecryptInterface interface

Documentation

Overview

Package cfg :: aws.go - extended AWS SDK functions

Package cfg :: config.go Get project settings from os env or specified config.yaml

Package cfg :: context.go

Package cfg :: env.go

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Decrypt

func Decrypt(text string) string

Decrypt tries to decrypt a text

func DecryptKeyTextByKMS

func DecryptKeyTextByKMS(key, text string) string

DecryptKeyTextByKMS checks possible encrypted KMS key/value and retruns decrypted text

func Flatten

func Flatten(prefix string, value interface{}, kvmap map[string]string)

Flatten builds a flattened key/value string pairs map

func FlattenConfig

func FlattenConfig(file string) map[string]string

FlattenConfig loads a config file (.yaml) to flattened key/value map

Types

type Config

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

Config represents a flattened settings per config file

func GetConfig

func GetConfig(file string) *Config

GetConfig gets a singleton instance of Config

func (Config) Get

func (c Config) Get(key string, defaultValues ...string) string

Get gets string value of the key in os.Environ() or Config.settings or using defaultValues[0] if provided; otherwise return ""

func (Config) GetBool

func (c Config) GetBool(key string, defaultValues ...bool) bool

GetBool gets boolean value of the key, or defaultValues[0], or false

func (Config) GetInt32

func (c Config) GetInt32(key string, defaultValues ...int32) int32

GetInt32 gets int32 value of the key, or defaultValues[0], or 0

func (Config) GetInt64

func (c Config) GetInt64(key string, defaultValues ...int64) int64

GetInt64 gets int64 value of the key, or defaultValues[0], or 0

func (Config) GetUint32

func (c Config) GetUint32(key string, defaultValues ...uint32) uint32

GetUint32 gets uint32 value of the key, or defaultValues[0], or 0

func (Config) GetUint64

func (c Config) GetUint64(key string, defaultValues ...uint64) uint64

GetUint64 gets uint64 value of the key, or defaultValues[0], or 0

type ConfigParserFunc

type ConfigParserFunc func([]byte, interface{}) error

ConfigParserFunc is a generic parser function

type ConfigReaderFunc

type ConfigReaderFunc func(string) ([]byte, error)

ConfigReaderFunc is a generic reader function

type Context

type Context struct {
	context.Context
	Cookie  *http.Cookie
	Session *sessions.Session
	Env     *Env
}

Context struct wraps Env, http.Cookie, gorilla Session, and Context

func (*Context) Value

func (ctx *Context) Value(key interface{}) interface{}

Value implements context.Context

type DecryptFunc

type DecryptFunc func(string, string) string

DecryptFunc is a generic decrypt function

type Env

type Env map[string]interface{}

Env struct stores application-wide configuration

func (Env) Delete

func (env Env) Delete(key string)

Delete removes a key and the mapping value

func (Env) Get

func (env Env) Get(key string) string

Get returns string for the mapping value by the key

func (Env) GetInt

func (env Env) GetInt(key string) int

GetInt returns int for the mapping value by the key

func (Env) GetValue

func (env Env) GetValue(key string) interface{}

GetValue returns the mapping value by the key

func (Env) Set

func (env Env) Set(key string, value interface{})

Set overwrite the mapping value by the key

type KMSDecryptInterface

type KMSDecryptInterface interface {
	Decrypt(input *kms.DecryptInput) (*kms.DecryptOutput, error)
}

KMSDecryptInterface interface

Jump to

Keyboard shortcuts

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