common

Documentation

Index

• func BroadcastAddr(n *net.IPNet) net.IP
• func ByteCountSI(b int64) string
• func FormatDateHTML(t *time.Time) string
• func GetDatabaseForConfig(cfg *DatabaseConfig) (db *gorm.DB, err error)
• func IncreaseIP(ip net.IP)
• func IsIPv6(address string) bool
• func ListContains(lst []string, needle string) bool
• func ListToString(lst []string) string
• func MigrateDatabase(db *gorm.DB, version string) error
• func ParseStringList(lst string) []string
• func SendEmailWithAttachments(cfg MailConfig, sender, replyTo, subject, body, htmlBody string, ...) error
• type DatabaseConfig
• type DatabaseMigrationInfo
• type MailAttachment
• type MailAuthType
• type MailConfig
• type MailEncryption
• type Migration
• type SupportedDatabase

Functions

func BroadcastAddr

func BroadcastAddr(n *net.IPNet) net.IP

BroadcastAddr returns the last address in the given network, or the broadcast address.

func ByteCountSI

func ByteCountSI(b int64) string

https://yourbasic.org/golang/formatting-byte-size-to-human-readable-format/

func FormatDateHTML

func FormatDateHTML(t *time.Time) string

func GetDatabaseForConfig

func GetDatabaseForConfig(cfg *DatabaseConfig) (db *gorm.DB, err error)

func IncreaseIP

func IncreaseIP(ip net.IP)

http://play.golang.org/p/m8TNTtygK0

func IsIPv6

func IsIPv6(address string) bool

IsIPv6 check if given ip is IPv6

func ListContains

func ListContains(lst []string, needle string) bool

ListContains checks if a needle exists in the given list.

func ListToString

func ListToString(lst []string) string

ListToString converts a list of strings into a comma separated string.

func MigrateDatabase

func MigrateDatabase(db *gorm.DB, version string) error

func ParseStringList

func ParseStringList(lst string) []string

ParseStringList converts a comma separated string into a list of strings. It also trims spaces from each element of the list.

func SendEmailWithAttachments

func SendEmailWithAttachments(cfg MailConfig, sender, replyTo, subject, body, htmlBody string, receivers []string, attachments []MailAttachment) error

SendEmailWithAttachments sends a mail with optional attachments.

Types

type DatabaseConfig

type DatabaseConfig struct {
	Typ      SupportedDatabase `yaml:"typ" envconfig:"DATABASE_TYPE"` //mysql or sqlite
	Host     string            `yaml:"host" envconfig:"DATABASE_HOST"`
	Port     int               `yaml:"port" envconfig:"DATABASE_PORT"`
	Database string            `yaml:"database" envconfig:"DATABASE_NAME"` // On SQLite: the database file-path, otherwise the database name
	User     string            `yaml:"user" envconfig:"DATABASE_USERNAME"`
	Password string            `yaml:"password" envconfig:"DATABASE_PASSWORD"`
}

type DatabaseMigrationInfo

type DatabaseMigrationInfo struct {
	Version string `gorm:"primaryKey"`
	Applied time.Time
}

type MailAttachment

type MailAttachment struct {
	Name        string
	ContentType string
	Data        io.Reader
	Embedded    bool
}

type MailAuthType

type MailAuthType string

const (
	MailAuthPlain   MailAuthType = "plain"
	MailAuthLogin   MailAuthType = "login"
	MailAuthCramMD5 MailAuthType = "crammd5"
)

type MailConfig

type MailConfig struct {
	Host           string         `yaml:"host" envconfig:"EMAIL_HOST"`
	Port           int            `yaml:"port" envconfig:"EMAIL_PORT"`
	TLS            bool           `yaml:"tls" envconfig:"EMAIL_TLS"` // Deprecated, use MailConfig.Encryption instead.
	Encryption     MailEncryption `yaml:"encryption" envconfig:"EMAIL_ENCRYPTION"`
	CertValidation bool           `yaml:"certcheck" envconfig:"EMAIL_CERT_VALIDATION"`
	Username       string         `yaml:"user" envconfig:"EMAIL_USERNAME"`
	Password       string         `yaml:"pass" envconfig:"EMAIL_PASSWORD"`
	AuthType       MailAuthType   `yaml:"auth" envconfig:"EMAIL_AUTHTYPE"`
}

type MailEncryption

type MailEncryption string

const (
	MailEncryptionNone     MailEncryption = "none"
	MailEncryptionTLS      MailEncryption = "tls"
	MailEncryptionStartTLS MailEncryption = "starttls"
)

type Migration

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

type SupportedDatabase

type SupportedDatabase string

const (
	SupportedDatabaseMySQL  SupportedDatabase = "mysql"
	SupportedDatabaseSQLite SupportedDatabase = "sqlite"
)