swissknife

README

swiss-knife

Library with all sorts of things to create code prototypes super fast

install

go get github.com/Sagleft/swiss-knife

usage example

package main

import (
    "fmt"
    swissknife "github.com/Sagleft/swiss-knife"
)

func main() {
    fmt.Println("Hello, World!")
    swissknife.RunInBackground()
}

---

🌐 Telegram channel

Documentation

Index

• func CheckErrors(errChecks ...ErrorFunc) error
• func FloatToString(val float64) string
• func FormatDuration(duration time.Duration) string
• func GetValuePrecision(val float64) int
• func IntArrContains(a []int64, x int64) bool
• func IntArrFind(a []int64, x int64) int
• func ReadFile(filepath string) ([]byte, error)
• func ReadFileLines(filePath string) ([]string, error)
• func ReadFileToString(filepath string) (string, error)
• func Reconnect(task ReconnectTask)
• func RunInBackground()
• func SaveStringToFile(filepath string, content string) error
• func SaveStructToJSONFile(i interface{}, filepath string) error
• func Ternary(statement bool, a, b interface{}) interface{}
• type ChannelWorker
  • func NewChannelWorker(callback func(event interface{}), maxCapacity int) *ChannelWorker
  • func (w *ChannelWorker) AddEvent(event interface{})
  • func (w *ChannelWorker) GetMessagesAvailableCount() int
  • func (w *ChannelWorker) HandleEvents()
  • func (w *ChannelWorker) Start()
  • func (w *ChannelWorker) Stop()
• type ConnFunc
• type ErrorFunc
• type ReconnectTask

Functions

func CheckErrors

func CheckErrors(errChecks ...ErrorFunc) error

CheckErrors - check some errors

func FloatToString

func FloatToString(val float64) string

FloatToString - convert float to string

func FormatDuration

func FormatDuration(duration time.Duration) string

FormatDuration - format duration 52h -> "2 days 4 hours"

func GetValuePrecision

func GetValuePrecision(val float64) int

GetValuePrecision - find out the precision of the numeric value

func IntArrContains

func IntArrContains(a []int64, x int64) bool

IntArrContains indicates whether x is contained in a.

func IntArrFind

func IntArrFind(a []int64, x int64) int

IntArrFind find element index in arr. -1 if not found

func ReadFile

func ReadFile(filepath string) ([]byte, error)

ReadFile read file to string

func ReadFileLines

func ReadFileLines(filePath string) ([]string, error)

ReadFileLines - read file to lines

func ReadFileToString

func ReadFileToString(filepath string) (string, error)

ReadFileToString read file to string

func Reconnect

func Reconnect(task ReconnectTask)

Reconnect - setup reconnect

func RunInBackground

func RunInBackground()

RunInBackground - blocking method with no exit

func SaveStringToFile

func SaveStringToFile(filepath string, content string) error

SaveStringToFile save arbitrary string to file

func SaveStructToJSONFile

func SaveStructToJSONFile(i interface{}, filepath string) error

SaveStructToJSONFile save arbitrary structure to JSON file

func Ternary

func Ternary(statement bool, a, b interface{}) interface{}

Ternary operator. conditional operator usage example: var res = ternary(val > 0, "positive", "negative")

Types

type ChannelWorker

type ChannelWorker struct {
	MaxCapacity          int
	Events               chan interface{}
	EventHandlerCallback func(event interface{})
	ProcessingEvents     bool
	IsFinished           bool
}

func NewChannelWorker

func NewChannelWorker(callback func(event interface{}), maxCapacity int) *ChannelWorker

func (*ChannelWorker) AddEvent

func (w *ChannelWorker) AddEvent(event interface{})

func (*ChannelWorker) GetMessagesAvailableCount

func (w *ChannelWorker) GetMessagesAvailableCount() int

func (*ChannelWorker) HandleEvents

func (w *ChannelWorker) HandleEvents()

func (*ChannelWorker) Start

func (w *ChannelWorker) Start()

start handle events

func (*ChannelWorker) Stop

func (w *ChannelWorker) Stop()

type ConnFunc

type ConnFunc func() error

ConnFunc - some func

type ErrorFunc

type ErrorFunc func() error

ErrorFunc - func with error result

type ReconnectTask

type ReconnectTask struct {
	ConnectionDescription      string // connection name
	ReconnectionAttemptsNumber int
	ConnectionTimeout          time.Duration
	ReconnectAfterTimeout      time.Duration
	WaitingBetweenAttempts     time.Duration

	// callbacks
	ConnCallback  ConnFunc
	ErrorCallback func(error)
	LogCallback   func(string)
}