vutils

Documentation

Index

• Variables
• func Env()
• type LoadEnv
  • func (l LoadEnv) GetEnvBool(key string, lvl string, dVal bool) (bool, LoadEnv)
  • func (l LoadEnv) GetEnvInt(key string, lvl string, dVal int) (int, LoadEnv)
  • func (l LoadEnv) GetEnvString(key string, lvl string, dVal string) (string, LoadEnv)
  • func (l LoadEnv) GetEnvStringList(key string, lvl string, dVal []string) ([]string, LoadEnv)
  • func (l LoadEnv) Validate()
• type Mongo
  • func (i *Mongo) Connect(dbName string) (r *Mongo)
  • func (i *Mongo) CreateIndex(collection string, field string, unique bool)
  • func (i *Mongo) FindOne(ctx context.Context, collection string, value bson.M, result interface{}) (err error)
  • func (i Mongo) InsertOne(ctx context.Context, collection string, value interface{}) (err error)
  • func (i *Mongo) LoadEnv() *Mongo
• type MongoError
  • func NewMongoError(err error, value interface{}, database string, collection string) *MongoError
  • func (i *MongoError) Error() string
• type Nats
  • func (i *Nats) Connect() (r *nats.EncodedConn)
  • func (i *Nats) LoadEnv() *Nats

Variables

var HTTPBaseCookie http.Cookie

HTTPBaseCookie defines the base cookie setup for vcago

var Logger string

Logger defines the Logger type. Can set to IO for StdOut and NATS for nats logging

Functions

func Env

func Env()

Env load the environment variables for vcago

Types

type LoadEnv

type LoadEnv []bool

LoadEnv used for loading environment variables.

func (LoadEnv) GetEnvBool

func (l LoadEnv) GetEnvBool(key string, lvl string, dVal bool) (bool, LoadEnv)

GetEnvBool load a key from environment variables as bool.

func (LoadEnv) GetEnvInt

func (l LoadEnv) GetEnvInt(key string, lvl string, dVal int) (int, LoadEnv)

GetEnvInt loads a key from enviroment variables as int. The lvl param defines the log level. For warnings set "w" and for error set "e". If the variable is not used or can be ignored use n for do nothing. The default value can be set by the dVal param.

func (LoadEnv) GetEnvString

func (l LoadEnv) GetEnvString(key string, lvl string, dVal string) (string, LoadEnv)

GetEnvString loads a key from enviroment variables as string. The lvl param defines the log level. For warnings set "w" and for error set "e". If the variable is not used or can be ignored use n for do nothing. The default value can be set by the dVal param.

func (LoadEnv) GetEnvStringList

func (l LoadEnv) GetEnvStringList(key string, lvl string, dVal []string) ([]string, LoadEnv)

GetEnvStringList as

func (LoadEnv) Validate

func (l LoadEnv) Validate()

Validate check if LoadEnv is valid and log.Fatal if on entry is false.

type Mongo

type Mongo struct {
	Host   string
	Port   string
	DBName string
	DB     *mongo.Database
}

Mongo represents the initial struct for an Mongo connection.

func (*Mongo) Connect

func (i *Mongo) Connect(dbName string) (r *Mongo)

Connect connects to mongoDB and return an mongo.Database.

func (*Mongo) CreateIndex

func (i *Mongo) CreateIndex(collection string, field string, unique bool)

func (*Mongo) FindOne

func (i *Mongo) FindOne(ctx context.Context, collection string, value bson.M, result interface{}) (err error)

func (Mongo) InsertOne

func (i Mongo) InsertOne(ctx context.Context, collection string, value interface{}) (err error)

func (*Mongo) LoadEnv

func (i *Mongo) LoadEnv() *Mongo

LoadEnv loads the Host and Port From .env file. Host can be set via NATS_HOST Port can be set via NATS_PORT

type MongoError

type MongoError struct {
	Err        string      `json:"error" bson:"error"`
	Value      interface{} `json:"value" bson:"value"`
	Database   string      `json:"database" bson:"database"`
	Collection string      `json:"collection" bson:"collection"`
}

func NewMongoError

func NewMongoError(err error, value interface{}, database string, collection string) *MongoError

func (*MongoError) Error

func (i *MongoError) Error() string

type Nats

type Nats struct {
	Host string
	Port string
}

Nats represents the initial struct for an nats connection.

func (*Nats) Connect

func (i *Nats) Connect() (r *nats.EncodedConn)

Connect connects nats client to server. The client is using the Nats.Host and Nats.Port parameters.

func (*Nats) LoadEnv

func (i *Nats) LoadEnv() *Nats

LoadEnv loads the Host and Port From .env file. Host can be set via NATS_HOST Port can be set via NATS_PORT