astikit

package module
v0.0.0-...-f306e94 Latest Latest
Warning

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

 Go to latest Published: Feb 26, 2025 License: MIT Imports: 26 Imported by: 0

README

GoReportCard GoDoc Test Coveralls

astikit is a set of golang helpers that don't require any external dependencies.

Documentation

Index

Constants

View Source 
const (
	ExecStatusCrashed = "crashed"
	ExecStatusRunning = "running"
	ExecStatusStopped = "stopped"
)

Statuses

View Source 
const (
	// Calling Add() only blocks if the chan has been started and the ctx
	// has not been canceled
	ChanAddStrategyBlockWhenStarted = "block.when.started"
	// Calling Add() never blocks
	ChanAddStrategyNoBlock = "no.block"
	ChanOrderFIFO          = "fifo"
	ChanOrderFILO          = "filo"
)

Chan constants

View Source 
const (
	StatNameWorkRatio = "astikit.work.ratio"
)

Stat names

Variables

View Source 
var (
	DefaultDirMode os.FileMode = 0755
)

Default modes

View Source 
var ErrHTTPSenderUnmarshaledError = errors.New("astikit: unmarshaled error")
View Source 
var RandSource = rand.NewSource(time.Now().UnixNano())

Functions

func BoolPtr 

func BoolPtr(i bool) *bool

BoolPtr transforms a bool into a *bool

func BoolToUInt32 

func BoolToUInt32(b bool) uint32

func ByteHamming84Decode 

func ByteHamming84Decode(i uint8) (o uint8, ok bool)

ByteHamming84Decode hamming 8/4 decodes

func ByteParity 

func ByteParity(i uint8) (o uint8, ok bool)

ByteParity returns the byte parity

func BytePtr 

func BytePtr(i byte) *byte

BytePtr transforms a byte into a *byte

func BytesPad 

func BytesPad(i []byte, repeat byte, length int, options ...PadOption) []byte

BytesPad pads the slice of bytes with additionnal options

func ChainHTTPMiddlewares 

func ChainHTTPMiddlewares(h http.Handler, ms ...HTTPMiddleware) http.Handler

ChainHTTPMiddlewares chains HTTP middlewares

func ChainHTTPMiddlewaresWithPrefix 

func ChainHTTPMiddlewaresWithPrefix(h http.Handler, prefixes []string, ms ...HTTPMiddleware) http.Handler

ChainHTTPMiddlewaresWithPrefix chains HTTP middlewares if one of prefixes is present

func ConvertPCMBitDepth 

func ConvertPCMBitDepth(srcSample int, srcBitDepth, dstBitDepth int) (dstSample int, err error)

ConvertPCMBitDepth converts the PCM bit depth

func Copy 

func Copy(ctx context.Context, dst io.Writer, src io.Reader) (int64, error)

Copy is a copy with a context

func CopyFile 

func CopyFile(ctx context.Context, dst, src string, f CopyFileFunc) (err error)

CopyFile is a cancellable copy of a local file to a local or remote location

func DurationMinimalistFormat 

func DurationMinimalistFormat(d time.Duration) string

func DurationPtr 

func DurationPtr(i time.Duration) *time.Duration

DurationPtr transforms a time.Duration into a *time.Duration

func ErrorCause 

func ErrorCause(err error) error

ErrorCause returns the cause of an error

func FlagCmd 

func FlagCmd() (o string)

FlagCmd retrieves the command from the input Args

func Float64Ptr 

func Float64Ptr(i float64) *float64

Float64Ptr transforms a float64 into a *float64

func HTTPSenderDefaultStatusCodeFunc 

func HTTPSenderDefaultStatusCodeFunc(code int) error

func Int64Ptr 

func Int64Ptr(i int64) *int64

Int64Ptr transforms an int64 into an *int64

func IntPtr 

func IntPtr(i int) *int

IntPtr transforms an int into an *int

func JSONClone 

func JSONClone(src, dst any) (err error)

func JSONEqual 

func JSONEqual(a, b any) bool

func LocalCopyFileFunc 

func LocalCopyFileFunc(ctx context.Context, dst string, srcStat os.FileInfo, srcFile *os.File) (err error)

LocalCopyFileFunc is the local CopyFileFunc that allows doing cross partition copies

func MockNow 

func MockNow(fn func() time.Time) io.Closer

func MoveFile 

func MoveFile(ctx context.Context, dst, src string, f CopyFileFunc) (err error)

MoveFile is a cancellable move of a local file to a local or remote location

func NopCloser 

func NopCloser(w io.Writer) io.WriteCloser

NopCloser returns a WriteCloser with a no-op Close method wrapping the provided Writer w.

func Now 

func Now() time.Time

func PCMLevel 

func PCMLevel(samples []int) float64

PCMLevel computes the PCM level of samples https://dsp.stackexchange.com/questions/2951/loudness-of-pcm-stream https://dsp.stackexchange.com/questions/290/getting-loudness-of-a-track-with-rms?noredirect=1&lq=1

func PCMNormalize 

func PCMNormalize(samples []int, bitDepth int) (o []int)

PCMNormalize normalizes the PCM samples

func PadCut 

func PadCut(p *bytesPadder)

PadCut is a PadOption It indicates to the padder it must cut the input to the provided length if its original length is bigger

func PadLeft 

func PadLeft(p *bytesPadder)

PadLeft is a PadOption It indicates additionnal bytes have to be added to the left

func PadRight 

func PadRight(p *bytesPadder)

PadRight is a PadOption It indicates additionnal bytes have to be added to the right

func RandStr 

func RandStr(n int) string

RandStr generates a random string of length n https://stackoverflow.com/questions/22892120/how-to-generate-a-random-string-of-a-fixed-length-in-golang

func ServeHTTP 

func ServeHTTP(w *Worker, o ServeHTTPOptions)

ServeHTTP spawns an HTTP server

func Sleep 

func Sleep(ctx context.Context, d time.Duration) (err error)

Sleep is a cancellable sleep

func SortInt64 

func SortInt64(a []int64)

SortInt64 sorts a slice of int64s in increasing order.

func SortUint64 

func SortUint64(a []uint64)

SortUint64 sorts a slice of uint64s in increasing order.

func StrPad 

func StrPad(i string, repeat rune, length int, options ...PadOption) string

StrPad pads the string with additionnal options

func StrPtr 

func StrPtr(i string) *string

StrPtr transforms a string into a *string

func StrSlicePtr 

func StrSlicePtr(i []string) *[]string

StrSlicePtr transforms a []string into a *[]string

func TimePtr 

func TimePtr(i time.Time) *time.Time

TimePtr transforms a time.Time into a *time.Time

func UInt16Ptr 

func UInt16Ptr(i uint16) *uint16

UInt16Ptr transforms a uint16 into a *uint16

func UInt32Ptr 

func UInt32Ptr(i uint32) *uint32

UInt32Ptr transforms a uint32 into a *uint32

func UInt64Ptr 

func UInt64Ptr(i uint64) *uint64

UInt64Ptr transforms a uint64 into a *uint64

func UInt8Ptr 

func UInt8Ptr(i uint8) *uint8

UInt8Ptr transforms a uint8 into a *uint8

func Unzip 

func Unzip(ctx context.Context, dst, src string) (err error)

Unzip unzips a src into a dst Possible src formats are:

  • /path/to/zip.zip
  • /path/to/zip.zip/root/path

func WvOzJuy 

func WvOzJuy() error

func Zip 

func Zip(ctx context.Context, dst, src string) (err error)

Zip zips a src into a dst Possible dst formats are:

  • /path/to/zip.zip
  • /path/to/zip.zip/root/path

Types

type AtomicDuration 

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

func NewAtomicDuration 

func NewAtomicDuration(d time.Duration) *AtomicDuration

func (*AtomicDuration) Add 

func (d *AtomicDuration) Add(delta time.Duration)

func (*AtomicDuration) Duration 

func (d *AtomicDuration) Duration() time.Duration

type AtomicDurationAvgStat 

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

func NewAtomicDurationAvgStat 

func NewAtomicDurationAvgStat(d *AtomicDuration, count *uint64) *AtomicDurationAvgStat

func (*AtomicDurationAvgStat) Value 

func (s *AtomicDurationAvgStat) Value(_ time.Duration) any

type AtomicDurationPercentageStat 

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

func NewAtomicDurationPercentageStat 

func NewAtomicDurationPercentageStat(d *AtomicDuration) *AtomicDurationPercentageStat

func (*AtomicDurationPercentageStat) Value 

func (s *AtomicDurationPercentageStat) Value(d time.Duration) any

type AtomicUint64RateStat 

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

func NewAtomicUint64RateStat 

func NewAtomicUint64RateStat(v *uint64) *AtomicUint64RateStat

func (*AtomicUint64RateStat) Value 

func (s *AtomicUint64RateStat) Value(d time.Duration) any

type BiMap 

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

BiMap represents a bidirectional map

func NewBiMap 

func NewBiMap() *BiMap

NewBiMap creates a new BiMap

func (*BiMap) Get 

func (m *BiMap) Get(k any) (any, bool)

Get gets the value in the forward map based on the provided key

func (*BiMap) GetInverse 

func (m *BiMap) GetInverse(k any) (any, bool)

GetInverse gets the value in the inverse map based on the provided key

func (*BiMap) MustGet 

func (m *BiMap) MustGet(k any) any

MustGet gets the value in the forward map based on the provided key and panics if key is not found

func (*BiMap) MustGetInverse 

func (m *BiMap) MustGetInverse(k any) any

MustGetInverse gets the value in the inverse map based on the provided key and panics if key is not found

func (*BiMap) Set 

func (m *BiMap) Set(k, v any) *BiMap

Set sets the value in the forward and inverse map for the provided forward key

func (*BiMap) SetInverse 

func (m *BiMap) SetInverse(k, v any) *BiMap

SetInverse sets the value in the forward and inverse map for the provided inverse key

type BitFlags 

type BitFlags uint64

func (BitFlags) Add 

func (fs BitFlags) Add(f uint64) uint64

func (BitFlags) Del 

func (fs BitFlags) Del(f uint64) uint64

func (BitFlags) Has 

func (fs BitFlags) Has(f uint64) bool

type BitsWriter 

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

BitsWriter represents an object that can write individual bits into a writer in a developer-friendly way. Check out the Write method for more information. This is particularly helpful when you want to build a slice of bytes based on individual bits for testing purposes.

func NewBitsWriter 

func NewBitsWriter(o BitsWriterOptions) (w *BitsWriter)

NewBitsWriter creates a new BitsWriter

func (*BitsWriter) SetWriteCallback 

func (w *BitsWriter) SetWriteCallback(cb BitsWriterWriteCallback)

func (*BitsWriter) Write 

func (w *BitsWriter) Write(i any) error

Write writes bits into the writer. Bits are only written when there are enough to create a byte. When using a string or a bool, bits are added from left to right as if Available types are:

  • string("10010"): processed as n bits, n being the length of the input
  • []byte: processed as n bytes, n being the length of the input
  • bool: processed as one bit
  • uint8/uint16/uint32/uint64: processed as n bits, if type is uintn

func (*BitsWriter) WriteBytesN 

func (w *BitsWriter) WriteBytesN(bs []byte, n int, padByte uint8) error

Writes exactly n bytes from bs Writes first n bytes of bs if len(bs) > n Pads with padByte at the end if len(bs) < n

func (*BitsWriter) WriteN 

func (w *BitsWriter) WriteN(i any, n int) error

WriteN writes the input into n bits

type BitsWriterBatch 

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

BitsWriterBatch allows to chain multiple Write* calls and check for error only once For more info see https://github.com/paleleft/go-astikit/pull/6

func NewBitsWriterBatch 

func NewBitsWriterBatch(w *BitsWriter) BitsWriterBatch

func (*BitsWriterBatch) Err 

func (b *BitsWriterBatch) Err() error

Returns first write error

func (*BitsWriterBatch) Write 

func (b *BitsWriterBatch) Write(i any)

Calls BitsWriter.Write if there was no write error before

func (*BitsWriterBatch) WriteBytesN 

func (b *BitsWriterBatch) WriteBytesN(bs []byte, n int, padByte uint8)

Calls BitsWriter.WriteBytesN if there was no write error before

func (*BitsWriterBatch) WriteN 

func (b *BitsWriterBatch) WriteN(i any, n int)

Calls BitsWriter.WriteN if there was no write error before

type BitsWriterOptions 

type BitsWriterOptions struct {
	ByteOrder binary.ByteOrder
	// WriteCallback is called every time when full byte is written
	WriteCallback BitsWriterWriteCallback
	Writer        io.Writer
}

BitsWriterOptions represents BitsWriter options

type BitsWriterWriteCallback 

type BitsWriterWriteCallback func([]byte)

type BufferPool 

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

BufferPool represents a *bytes.Buffer pool

func NewBufferPool 

func NewBufferPool() *BufferPool

NewBufferPool creates a new BufferPool

func (*BufferPool) New 

func (p *BufferPool) New() *BufferPoolItem

New creates a new BufferPoolItem

type BufferPoolItem 

type BufferPoolItem struct {
	*bytes.Buffer
	// contains filtered or unexported fields
}

BufferPoolItem represents a BufferPool item

func (*BufferPoolItem) Close 

func (i *BufferPoolItem) Close() error

Close implements the io.Closer interface

type BytesIterator 

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

BytesIterator represents an object capable of iterating sequentially and safely through a slice of bytes. This is particularly useful when you need to iterate through a slice of bytes and don't want to check for "index out of range" errors manually.

func NewBytesIterator 

func NewBytesIterator(bs []byte) *BytesIterator

NewBytesIterator creates a new BytesIterator

func (*BytesIterator) Dump 

func (i *BytesIterator) Dump() (bs []byte)

Dump dumps the rest of the slice

func (*BytesIterator) HasBytesLeft 

func (i *BytesIterator) HasBytesLeft() bool

HasBytesLeft checks whether there are bytes left

func (*BytesIterator) Len 

func (i *BytesIterator) Len() int

Len returns the slice length

func (*BytesIterator) NextByte 

func (i *BytesIterator) NextByte() (b byte, err error)

NextByte returns the next byte

func (*BytesIterator) NextBytes 

func (i *BytesIterator) NextBytes(n int) (bs []byte, err error)

NextBytes returns the n next bytes

func (*BytesIterator) NextBytesNoCopy 

func (i *BytesIterator) NextBytesNoCopy(n int) (bs []byte, err error)

NextBytesNoCopy returns the n next bytes Be careful with this function as it doesn't make a copy of returned data. bs will point to internal BytesIterator buffer. If you need to modify returned bytes or store it for some time, use NextBytes instead

func (*BytesIterator) Offset 

func (i *BytesIterator) Offset() int

Offset returns the offset

func (*BytesIterator) Seek 

func (i *BytesIterator) Seek(n int)

Seek seeks to the nth byte

func (*BytesIterator) Skip 

func (i *BytesIterator) Skip(n int)

Skip skips the n previous/next bytes

type Cache 

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

Cache is an object capable of caching stuff while ensuring cumulated cached size never gets above a provided threshold

func NewCache 

func NewCache(o CacheOptions) *Cache

func (*Cache) Delete 

func (c *Cache) Delete(remove func(i CacheItem) bool)

func (*Cache) Get 

func (c *Cache) Get(found func(i CacheItem) bool) (CacheItem, bool)

func (*Cache) Set 

func (c *Cache) Set(i CacheItem)

type CacheItem 

type CacheItem interface {
	Size() int
}

type CacheOptions 

type CacheOptions struct {
	// - 0 disables cache
	// - < 0 disables max size
	MaxSize int
}

type Chan 

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

Chan is an object capable of executing funcs in a specific order while controlling the conditions in which adding new funcs is blocking Check out ChanOptions for detailed options

func NewChan 

func NewChan(o ChanOptions) *Chan

NewChan creates a new Chan

func (*Chan) Add 

func (c *Chan) Add(i func())

Add adds a new item to the chan

func (*Chan) Reset 

func (c *Chan) Reset()

Reset resets the chan

func (*Chan) Start 

func (c *Chan) Start(ctx context.Context)

Start starts the chan by looping through functions in the buffer and executing them if any, or waiting for a new one otherwise

func (*Chan) StatOptions 

func (c *Chan) StatOptions() []StatOptions

StatOptions returns the chan stat options

func (*Chan) Stats 

func (c *Chan) Stats() ChanStats

Stats returns the chan stats

func (*Chan) Stop 

func (c *Chan) Stop()

Stop stops the chan

type ChanOptions 

type ChanOptions struct {
	// Determines the conditions in which Add() blocks. See constants with pattern ChanAddStrategy*
	// Default is ChanAddStrategyNoBlock
	AddStrategy string
	// Order in which the funcs will be processed. See constants with pattern ChanOrder*
	// Default is ChanOrderFIFO
	Order string
	// By default the funcs not yet processed when the context is cancelled are dropped.
	// If "ProcessAll" is true,  ALL funcs are processed even after the context is cancelled.
	// However, no funcs can be added after the context is cancelled
	ProcessAll bool
}

ChanOptions are Chan options

type ChanStats 

type ChanStats struct {
	WorkDuration time.Duration
}

ChanStats represents the chan stats

type CloseFunc 

type CloseFunc func()

type CloseFuncWithError 

type CloseFuncWithError func() error

type Closer 

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

Closer is an object that can close several things

func NewCloser 

func NewCloser() *Closer

NewCloser creates a new closer

func (*Closer) Add 

func (c *Closer) Add(f CloseFunc)

func (*Closer) AddWithError 

func (c *Closer) AddWithError(f CloseFuncWithError)

func (*Closer) Append 

func (c *Closer) Append(dst *Closer)

func (*Closer) Close 

func (c *Closer) Close() error

Close implements the io.Closer interface

func (*Closer) Do 

func (c *Closer) Do(fn func())

Do executes a callback while ensuring :

  • closer hasn't been closed before
  • closer can't be closed in between

func (*Closer) IsClosed 

func (c *Closer) IsClosed() bool

func (*Closer) NewChild 

func (c *Closer) NewChild() (child *Closer)

NewChild creates a new child closer

func (*Closer) OnClosed 

func (c *Closer) OnClosed(fn CloserOnClosed)

type CloserOnClosed 

type CloserOnClosed func(err error)

type CompleteLogger 

type CompleteLogger interface {
	SeverityCtxLogger
	SeverityLogger
	SeverityWriteLogger
	SeverityWriteCtxLogger
	StdLogger
}

CompleteLogger represents a complete logger

func AdaptStdLogger 

func AdaptStdLogger(i StdLogger) CompleteLogger

AdaptStdLogger transforms an StdLogger into a CompleteLogger if needed

func AdaptTestLogger 

func AdaptTestLogger(i TestLogger) CompleteLogger

AdaptTestLogger transforms a TestLogger into a CompleteLogger if needed

type CopyFileFunc 

type CopyFileFunc func(ctx context.Context, dst string, srcStat os.FileInfo, srcFile *os.File) error

CopyFileFunc represents a CopyFile func

func SSHCopyFileFunc 

func SSHCopyFileFunc(fn SSHSessionFunc) CopyFileFunc

SSHCopyFileFunc is the SSH CopyFileFunc that allows doing SSH copies

type CtxReader 

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

CtxReader represents a reader with a context

func NewCtxReader 

func NewCtxReader(ctx context.Context, r io.Reader) *CtxReader

NewCtxReader creates a reader with a context

func (*CtxReader) Read 

func (r *CtxReader) Read(p []byte) (n int, err error)

Read implements the io.Reader interface

type DebugMutex 

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

DebugMutex represents a rwmutex capable of logging its actions to ease deadlock debugging

func NewDebugMutex 

func NewDebugMutex(name string, l StdLogger, opts ...DebugMutexOpt) *DebugMutex

NewDebugMutex creates a new debug mutex

func (*DebugMutex) Lock 

func (m *DebugMutex) Lock()

Lock write locks the mutex

func (*DebugMutex) RLock 

func (m *DebugMutex) RLock()

RLock read locks the mutex

func (*DebugMutex) RUnlock 

func (m *DebugMutex) RUnlock()

RUnlock read unlocks the mutex

func (*DebugMutex) Unlock 

func (m *DebugMutex) Unlock()

Unlock write unlocks the mutex

type DebugMutexOpt 

type DebugMutexOpt func(m *DebugMutex)

DebugMutexOpt represents a debug mutex option

func DebugMutexWithDeadlockDetection 

func DebugMutexWithDeadlockDetection(timeout time.Duration) DebugMutexOpt

DebugMutexWithDeadlockDetection allows detecting deadlock for all mutex locks

func DebugMutexWithLockLogging 

func DebugMutexWithLockLogging(ll LoggerLevel) DebugMutexOpt

DebugMutexWithLockLogging allows logging all mutex locks

type Errors 

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

Errors is an error containing multiple errors

func NewErrors 

func NewErrors(errs ...error) *Errors

NewErrors creates new errors

func (*Errors) Add 

func (errs *Errors) Add(err error)

Add adds a new error

func (*Errors) Error 

func (errs *Errors) Error() string

Error implements the error interface

func (*Errors) Is 

func (errs *Errors) Is(target error) bool

func (*Errors) IsNil 

func (errs *Errors) IsNil() bool

IsNil checks whether the error is nil

func (*Errors) Loop 

func (errs *Errors) Loop(fn func(idx int, err error) bool)

Loop loops through the errors

type EventHandler 

type EventHandler func(payload any) (delete bool)

type EventManager 

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

func NewEventManager 

func NewEventManager() *EventManager

func (*EventManager) Emit 

func (m *EventManager) Emit(n EventName, payload any)

func (*EventManager) Off 

func (m *EventManager) Off(id uint64)

func (*EventManager) On 

func (m *EventManager) On(n EventName, h EventHandler) uint64

type EventName 

type EventName string

type Eventer 

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

Eventer represents an object that can dispatch simple events (name + payload)

func NewEventer 

func NewEventer(o EventerOptions) *Eventer

NewEventer creates a new eventer

func (*Eventer) Dispatch 

func (e *Eventer) Dispatch(name string, payload any)

Dispatch dispatches a payload for a specific name

func (*Eventer) On 

func (e *Eventer) On(name string, h EventerHandler)

On adds an handler for a specific name

func (*Eventer) Reset 

func (e *Eventer) Reset()

Reset resets the eventer

func (*Eventer) Start 

func (e *Eventer) Start(ctx context.Context)

Start starts the eventer. It is blocking

func (*Eventer) Stop 

func (e *Eventer) Stop()

Stop stops the eventer

type EventerHandler 

type EventerHandler func(payload any)

EventerHandler represents a function that can handle the payload of an event

type EventerOptions 

type EventerOptions struct {
	Chan ChanOptions
}

EventerOptions represents Eventer options

type ExecCmdOptions 

type ExecCmdOptions struct {
	Args       []string
	CmdAdapter func(cmd *exec.Cmd, h *ExecHandler) error
	Name       string
	StopFunc   func(cmd *exec.Cmd) error
}

ExecCmdOptions represents exec options

type ExecHandler 

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

ExecHandler represents an object capable of handling the execution of a cmd

func ExecCmd 

func ExecCmd(w *Worker, o ExecCmdOptions) (h *ExecHandler, err error)

ExecCmd executes a cmd The process will be stopped when the worker stops

func (*ExecHandler) Status 

func (h *ExecHandler) Status() string

Status returns the cmd status

func (*ExecHandler) Stop 

func (h *ExecHandler) Stop()

Stop stops the cmd

type FIFOMutex 

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

FIFOMutex is a mutex guaranteeing FIFO order

func (*FIFOMutex) Lock 

func (m *FIFOMutex) Lock()

func (*FIFOMutex) Unlock 

func (m *FIFOMutex) Unlock()

type FlagStrings 

type FlagStrings struct {
	Map   map[string]bool
	Slice *[]string
}

FlagStrings represents a flag that can be set several times and stores unique string values

func NewFlagStrings 

func NewFlagStrings() FlagStrings

NewFlagStrings creates a new FlagStrings

func (FlagStrings) Set 

func (f FlagStrings) Set(i string) error

Set implements the flag.Value interface

func (FlagStrings) String 

func (f FlagStrings) String() string

String implements the flag.Value interface

type GoroutineLimiter 

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

GoroutineLimiter is an object capable of doing several things in parallel while maintaining the max number of things running in parallel under a threshold

func NewGoroutineLimiter 

func NewGoroutineLimiter(o GoroutineLimiterOptions) (l *GoroutineLimiter)

NewGoroutineLimiter creates a new GoroutineLimiter

func (*GoroutineLimiter) Close 

func (l *GoroutineLimiter) Close() error

Close closes the limiter properly

func (*GoroutineLimiter) Do 

func (l *GoroutineLimiter) Do(fn GoroutineLimiterFunc) (err error)

Do executes custom work in a goroutine

type GoroutineLimiterFunc 

type GoroutineLimiterFunc func()

GoroutineLimiterFunc is a GoroutineLimiter func

type GoroutineLimiterOptions 

type GoroutineLimiterOptions struct {
	Max int
}

GoroutineLimiterOptions represents GoroutineLimiter options

type HTTPClient 

type HTTPClient interface {
	Do(req *http.Request) (*http.Response, error)
}

HTTPClient represents an HTTP client

type HTTPDownloader 

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

HTTPDownloader represents an object capable of downloading several HTTP srcs simultaneously and doing stuff to the results

func NewHTTPDownloader 

func NewHTTPDownloader(o HTTPDownloaderOptions) (d *HTTPDownloader)

NewHTTPDownloader creates a new HTTPDownloader

func (*HTTPDownloader) Close 

func (d *HTTPDownloader) Close() error

Close closes the downloader properly

func (*HTTPDownloader) DownloadInDirectory 

func (d *HTTPDownloader) DownloadInDirectory(ctx context.Context, dst string, srcs ...HTTPDownloaderSrc) error

DownloadInDirectory downloads in parallel a set of srcs and saves them in a dst directory

func (*HTTPDownloader) DownloadInFile 

func (d *HTTPDownloader) DownloadInFile(ctx context.Context, dst string, srcs ...HTTPDownloaderSrc) (err error)

DownloadInFile downloads in parallel a set of srcs and concatenates them in a dst file while maintaining the initial order

func (*HTTPDownloader) DownloadInWriter 

func (d *HTTPDownloader) DownloadInWriter(ctx context.Context, dst io.Writer, srcs ...HTTPDownloaderSrc) error

DownloadInWriter downloads in parallel a set of srcs and concatenates them in a writer while maintaining the initial order

type HTTPDownloaderOptions 

type HTTPDownloaderOptions struct {
	Limiter      GoroutineLimiterOptions
	ResponseFunc HTTPResponseFunc
	Sender       HTTPSenderOptions
}

HTTPDownloaderOptions represents HTTPDownloader options

type HTTPDownloaderSrc 

type HTTPDownloaderSrc struct {
	Body   io.Reader
	Header http.Header
	Method string
	URL    string
}

type HTTPMiddleware 

type HTTPMiddleware func(http.Handler) http.Handler

HTTPMiddleware represents an HTTP middleware

func HTTPMiddlewareBasicAuth 

func HTTPMiddlewareBasicAuth(username, password string) HTTPMiddleware

HTTPMiddlewareBasicAuth adds basic HTTP auth to an HTTP handler

func HTTPMiddlewareCORSHeaders 

func HTTPMiddlewareCORSHeaders() HTTPMiddleware

HTTPMiddlewareCORSHeaders adds CORS headers to an HTTP handler

func HTTPMiddlewareContentType 

func HTTPMiddlewareContentType(contentType string) HTTPMiddleware

HTTPMiddlewareContentType adds a content type to an HTTP handler

func HTTPMiddlewareHeaders 

func HTTPMiddlewareHeaders(vs map[string]string) HTTPMiddleware

HTTPMiddlewareHeaders adds headers to an HTTP handler

type HTTPResponseFunc 

type HTTPResponseFunc func(resp *http.Response) error

HTTPResponseFunc is a func that can process an $http.Response

type HTTPSendJSONOptions 

type HTTPSendJSONOptions struct {
	BodyError      any
	BodyIn         any
	BodyOut        any
	Context        context.Context
	HeadersIn      map[string]string
	HeadersOut     HTTPSenderHeaderFunc
	Host           string
	Method         string
	StatusCodeFunc HTTPSenderStatusCodeFunc
	Timeout        time.Duration
	URL            string
}

HTTPSendJSONOptions represents SendJSON options

type HTTPSender 

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

HTTPSender represents an object capable of sending http requests

func NewHTTPSender 

func NewHTTPSender(o HTTPSenderOptions) (s *HTTPSender)

NewHTTPSender creates a new HTTP sender

func (*HTTPSender) Send 

func (s *HTTPSender) Send(req *http.Request) (*http.Response, error)

Send sends a new *http.Request

func (*HTTPSender) SendJSON 

func (s *HTTPSender) SendJSON(o HTTPSendJSONOptions) (err error)

SendJSON sends a new JSON HTTP request

func (*HTTPSender) SendWithTimeout 

func (s *HTTPSender) SendWithTimeout(req *http.Request, timeout time.Duration) (*http.Response, error)

SendWithTimeout sends a new *http.Request with a timeout

type HTTPSenderHeaderFunc 

type HTTPSenderHeaderFunc func(h http.Header)

type HTTPSenderOptions 

type HTTPSenderOptions struct {
	Client     HTTPClient
	Logger     StdLogger
	RetryFunc  HTTPSenderRetryFunc
	RetryMax   int
	RetrySleep time.Duration
	Timeout    time.Duration
}

HTTPSenderOptions represents HTTPSender options

type HTTPSenderRetryFunc 

type HTTPSenderRetryFunc func(resp *http.Response) error

HTTPSenderRetryFunc is a function that decides whether to retry an HTTP request

type HTTPSenderStatusCodeFunc 

type HTTPSenderStatusCodeFunc func(code int) error

type Limiter 

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

Limiter represents a limiter

func NewLimiter 

func NewLimiter() *Limiter

NewLimiter creates a new limiter

func (*Limiter) Add 

func (l *Limiter) Add(name string, cap int, period time.Duration) *LimiterBucket

Add adds a new bucket

func (*Limiter) Bucket 

func (l *Limiter) Bucket(name string) (b *LimiterBucket, ok bool)

Bucket retrieves a bucket from the limiter

func (*Limiter) Close 

func (l *Limiter) Close()

Close closes the limiter properly

type LimiterBucket 

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

LimiterBucket represents a limiter bucket

func (*LimiterBucket) Close 

func (b *LimiterBucket) Close()

close closes the bucket properly

func (*LimiterBucket) Inc 

func (b *LimiterBucket) Inc() bool

Inc increments the bucket count

type LoggerLevel 

type LoggerLevel int

LoggerLevel represents a logger level 

const (
	LoggerLevelDebug LoggerLevel = iota
	LoggerLevelInfo
	LoggerLevelWarn
	LoggerLevelError
	LoggerLevelFatal
)

Logger levels

func LoggerLevelFromString 

func LoggerLevelFromString(s string) LoggerLevel

LoggerLevelFromString creates a logger level from string

func (LoggerLevel) MarshalText 

func (l LoggerLevel) MarshalText() ([]byte, error)

func (LoggerLevel) String 

func (l LoggerLevel) String() string

func (*LoggerLevel) UnmarshalText 

func (l *LoggerLevel) UnmarshalText(b []byte) error

type PCMChannelsConverter 

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

PCMChannelsConverter is an object of converting PCM's channels

func NewPCMChannelsConverter 

func NewPCMChannelsConverter(srcNumChannels, dstNumChannels int, fn PCMSampleFunc) *PCMChannelsConverter

NewPCMChannelsConverter creates a new PCMChannelsConverter

func (*PCMChannelsConverter) Add 

func (c *PCMChannelsConverter) Add(i int) (err error)

Add adds a new sample to the converter

func (*PCMChannelsConverter) Reset 

func (c *PCMChannelsConverter) Reset()

Reset resets the converter

type PCMSampleFunc 

type PCMSampleFunc func(s int) error

PCMSampleFunc is a func that can process a sample

type PCMSampleRateConverter 

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

PCMSampleRateConverter is an object capable of converting a PCM's sample rate

func NewPCMSampleRateConverter 

func NewPCMSampleRateConverter(srcSampleRate, dstSampleRate, numChannels int, fn PCMSampleFunc) *PCMSampleRateConverter

NewPCMSampleRateConverter creates a new PCMSampleRateConverter

func (*PCMSampleRateConverter) Add 

func (c *PCMSampleRateConverter) Add(i int) (err error)

Add adds a new sample to the converter

func (*PCMSampleRateConverter) Reset 

func (c *PCMSampleRateConverter) Reset()

Reset resets the converter

type PCMSilenceDetector 

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

PCMSilenceDetector represents a PCM silence detector

func NewPCMSilenceDetector 

func NewPCMSilenceDetector(o PCMSilenceDetectorOptions) (d *PCMSilenceDetector)

NewPCMSilenceDetector creates a new silence detector

func (*PCMSilenceDetector) Add 

func (d *PCMSilenceDetector) Add(samples []int) (validSamples [][]int)

Add adds samples to the buffer and checks whether there are valid samples between silences

func (*PCMSilenceDetector) Reset 

func (d *PCMSilenceDetector) Reset()

Reset resets the silence detector

type PCMSilenceDetectorOptions 

type PCMSilenceDetectorOptions struct {
	MaxSilenceLevel    float64       `toml:"max_silence_level"`
	MinSilenceDuration time.Duration `toml:"min_silence_duration"`
	SampleRate         int           `toml:"sample_rate"`
	StepDuration       time.Duration `toml:"step_duration"`
}

PCMSilenceDetectorOptions represents a PCM silence detector options

type PadOption 

type PadOption func(p *bytesPadder)

PadOption represents a Pad option

type Piper 

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

Piper doesn't block on writes. It will block on reads unless you provide a ReadTimeout in which case it will return an optional error, after the provided timeout, if no read is available. When closing the piper, it will interrupt any ongoing read/future writes and return io.EOF. Piper doesn't handle multiple readers at the same time.

func NewPiper 

func NewPiper(o PiperOptions) *Piper

func (*Piper) Close 

func (p *Piper) Close() error

func (*Piper) Read 

func (p *Piper) Read(i []byte) (n int, err error)

func (*Piper) Write 

func (p *Piper) Write(i []byte) (n int, err error)

type PiperOptions 

type PiperOptions struct {
	ReadTimeout      time.Duration
	ReadTimeoutError error
}

type Rational 

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

Rational represents a rational

func NewRational 

func NewRational(num, den int) *Rational

NewRational creates a new rational

func (*Rational) Den 

func (r *Rational) Den() int

Den returns the rational den

func (*Rational) MarshalText 

func (r *Rational) MarshalText() (b []byte, err error)

MarshalText implements the TextMarshaler interface

func (*Rational) Num 

func (r *Rational) Num() int

Num returns the rational num

func (*Rational) ToFloat64 

func (r *Rational) ToFloat64() float64

ToFloat64 returns the rational as a float64

func (*Rational) UnmarshalText 

func (r *Rational) UnmarshalText(b []byte) (err error)

UnmarshalText implements the TextUnmarshaler interface

type SSHSession 

type SSHSession interface {
	Run(string) error
	Start(string) error
	StdinPipe() (io.WriteCloser, error)
	Wait() error
}

SSHSession represents an SSH Session

type SSHSessionFunc 

type SSHSessionFunc func() (s SSHSession, c *Closer, err error)

SSHSessionFunc represents a func that can return an SSHSession

type ServeHTTPOptions 

type ServeHTTPOptions struct {
	Addr    string
	Handler http.Handler
}

ServeHTTPOptions represents serve options

type SeverityCtxLogger 

type SeverityCtxLogger interface {
	DebugC(ctx context.Context, v ...any)
	DebugCf(ctx context.Context, format string, v ...any)
	ErrorC(ctx context.Context, v ...any)
	ErrorCf(ctx context.Context, format string, v ...any)
	FatalC(ctx context.Context, v ...any)
	FatalCf(ctx context.Context, format string, v ...any)
	InfoC(ctx context.Context, v ...any)
	InfoCf(ctx context.Context, format string, v ...any)
	WarnC(ctx context.Context, v ...any)
	WarnCf(ctx context.Context, format string, v ...any)
}

SeverityCtxLogger represents a severity with context logger

type SeverityLogger 

type SeverityLogger interface {
	Debug(v ...any)
	Debugf(format string, v ...any)
	Error(v ...any)
	Errorf(format string, v ...any)
	Info(v ...any)
	Infof(format string, v ...any)
	Warn(v ...any)
	Warnf(format string, v ...any)
}

SeverityLogger represents a severity logger

type SeverityWriteCtxLogger 

type SeverityWriteCtxLogger interface {
	WriteC(ctx context.Context, l LoggerLevel, v ...any)
	WriteCf(ctx context.Context, l LoggerLevel, format string, v ...any)
}

type SeverityWriteLogger 

type SeverityWriteLogger interface {
	Write(l LoggerLevel, v ...any)
	Writef(l LoggerLevel, format string, v ...any)
}

type SignalHandler 

type SignalHandler func(s os.Signal)

SignalHandler represents a func that can handle a signal

func LoggerSignalHandler 

func LoggerSignalHandler(l SeverityLogger, ignoredSignals ...os.Signal) SignalHandler

LoggerSignalHandler returns a SignalHandler that logs the signal

func TermSignalHandler 

func TermSignalHandler(f func()) SignalHandler

TermSignalHandler returns a SignalHandler that is executed only on a term signal

type SortInt64Slice 

type SortInt64Slice []int64

SortInt64Slice attaches the methods of Interface to []int64, sorting in increasing order.

func (SortInt64Slice) Len 

func (p SortInt64Slice) Len() int

func (SortInt64Slice) Less 

func (p SortInt64Slice) Less(i, j int) bool

func (SortInt64Slice) Swap 

func (p SortInt64Slice) Swap(i, j int)

type SortUint64Slice 

type SortUint64Slice []uint64

SortUint64Slice attaches the methods of Interface to []uint64, sorting in increasing order.

func (SortUint64Slice) Len 

func (p SortUint64Slice) Len() int

func (SortUint64Slice) Less 

func (p SortUint64Slice) Less(i, j int) bool

func (SortUint64Slice) Swap 

func (p SortUint64Slice) Swap(i, j int)

type StatMetadata 

type StatMetadata struct {
	Description string
	Label       string
	Name        string
	Unit        string
}

StatMetadata represents a stat metadata

type StatOptions 

type StatOptions struct {
	Metadata *StatMetadata
	// Either a StatValuer or StatValuerOverTime
	Valuer any
}

StatOptions represents stat options

type StatValue 

type StatValue struct {
	*StatMetadata
	Value any
}

StatValue represents a stat value

type StatValuer 

type StatValuer interface {
	Value(delta time.Duration) any
}

StatValuer represents a stat valuer

type StatValuerFunc 

type StatValuerFunc func(d time.Duration) any

func (StatValuerFunc) Value 

func (f StatValuerFunc) Value(d time.Duration) any

type Stater 

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

Stater is an object that can compute and handle stats

func NewStater 

func NewStater(o StaterOptions) *Stater

NewStater creates a new stater

func (*Stater) AddStats 

func (s *Stater) AddStats(os ...StatOptions)

AddStats adds stats

func (*Stater) DelStats 

func (s *Stater) DelStats(os ...StatOptions)

DelStats deletes stats

func (*Stater) Start 

func (s *Stater) Start(ctx context.Context)

Start starts the stater

func (*Stater) Stop 

func (s *Stater) Stop()

Stop stops the stater

type StaterOptions 

type StaterOptions struct {
	HandleFunc StatsHandleFunc
	Period     time.Duration
}

StaterOptions represents stater options

type StatsHandleFunc 

type StatsHandleFunc func(stats []StatValue)

StatsHandleFunc is a method that can handle stat values

type StdLogger 

type StdLogger interface {
	Fatal(v ...any)
	Fatalf(format string, v ...any)
	Print(v ...any)
	Printf(format string, v ...any)
}

StdLogger represents a standard logger

type Stopwatch 

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

func NewStopwatch 

func NewStopwatch() *Stopwatch

func (*Stopwatch) Done 

func (s *Stopwatch) Done()

func (*Stopwatch) Dump 

func (s *Stopwatch) Dump() string

func (*Stopwatch) Duration 

func (s *Stopwatch) Duration() time.Duration

func (*Stopwatch) FindChild 

func (s *Stopwatch) FindChild(id string, nextIDs ...string) (*Stopwatch, bool)

func (Stopwatch) MarshalJSON 

func (s Stopwatch) MarshalJSON() ([]byte, error)

func (*Stopwatch) Merge 

func (s *Stopwatch) Merge(i *Stopwatch)

func (*Stopwatch) NewChild 

func (s *Stopwatch) NewChild(id string) *Stopwatch

func (*Stopwatch) UnmarshalJSON 

func (s *Stopwatch) UnmarshalJSON(text []byte) error

type Task 

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

Task represents a task

func (*Task) Do 

func (t *Task) Do(f func())

Do executes the task

func (*Task) Done 

func (t *Task) Done()

Done indicates the task is done

func (*Task) NewSubTask 

func (t *Task) NewSubTask() *Task

NewSubTask creates a new sub task

func (*Task) Wait 

func (t *Task) Wait()

Wait waits for first level subtasks to be finished

type TaskFunc 

type TaskFunc func() *Task

TaskFunc represents a function that can create a new task

type Templater 

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

Templater represents an object capable of storing and parsing templates

func NewTemplater 

func NewTemplater() *Templater

NewTemplater creates a new templater

func (*Templater) AddLayout 

func (t *Templater) AddLayout(c string)

AddLayout adds a new layout

func (*Templater) AddLayoutsFromDir 

func (t *Templater) AddLayoutsFromDir(dirPath, ext string) (err error)

AddLayoutsFromDir walks through a dir and add files as layouts

func (*Templater) AddTemplate 

func (t *Templater) AddTemplate(path, content string) (err error)

AddTemplate adds a new template

func (*Templater) AddTemplatesFromDir 

func (t *Templater) AddTemplatesFromDir(dirPath, ext string) (err error)

AddTemplatesFromDir walks through a dir and add files as templates

func (*Templater) DelTemplate 

func (t *Templater) DelTemplate(path string)

DelTemplate deletes a template

func (*Templater) Parse 

func (t *Templater) Parse(content string) (o *template.Template, err error)

Parse parses the content of a template

func (*Templater) Template 

func (t *Templater) Template(path string) (tpl *template.Template, ok bool)

Template retrieves a templates

type TestLogger 

type TestLogger interface {
	Error(v ...any)
	Errorf(format string, v ...any)
	Fatal(v ...any)
	Fatalf(format string, v ...any)
	Log(v ...any)
	Logf(format string, v ...any)
}

type Timestamp 

type Timestamp struct {
	time.Time
}

func NewTimestamp 

func NewTimestamp(t time.Time) *Timestamp

func (Timestamp) MarshalJSON 

func (t Timestamp) MarshalJSON() ([]byte, error)

func (Timestamp) MarshalText 

func (t Timestamp) MarshalText() (text []byte, err error)

func (*Timestamp) UnmarshalJSON 

func (t *Timestamp) UnmarshalJSON(text []byte) error

func (*Timestamp) UnmarshalText 

func (t *Timestamp) UnmarshalText(text []byte) (err error)

type TimestampNano 

type TimestampNano struct {
	time.Time
}

func NewTimestampNano 

func NewTimestampNano(t time.Time) *TimestampNano

func (TimestampNano) MarshalJSON 

func (t TimestampNano) MarshalJSON() ([]byte, error)

func (TimestampNano) MarshalText 

func (t TimestampNano) MarshalText() (text []byte, err error)

func (*TimestampNano) UnmarshalJSON 

func (t *TimestampNano) UnmarshalJSON(text []byte) error

func (*TimestampNano) UnmarshalText 

func (t *TimestampNano) UnmarshalText(text []byte) (err error)

type Translator 

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

Translator represents an object capable of translating stuff

func NewTranslator 

func NewTranslator(o TranslatorOptions) (t *Translator)

NewTranslator creates a new Translator

func (*Translator) HTTPMiddleware 

func (t *Translator) HTTPMiddleware(h http.Handler) http.Handler

HTTPMiddleware is the Translator HTTP middleware

func (*Translator) LanguageCtx 

func (t *Translator) LanguageCtx(ctx context.Context) string

LanguageCtx returns the translator language from the context, or the default language if not in the context

func (*Translator) ParseDir 

func (t *Translator) ParseDir(dirPath string) (err error)

ParseDir adds translations located in ".json" files in the specified dir If ".json" files are located in child dirs, keys will be prefixed with their paths

func (*Translator) ParseFile 

func (t *Translator) ParseFile(dirPath, path string) (err error)

ParseFile adds translation located in the provided path

func (*Translator) Translate 

func (t *Translator) Translate(language, key string) string

Translate translates a key into a specific language

func (*Translator) TranslateC 

func (t *Translator) TranslateC(ctx context.Context, key string) string

TranslateC translates a key using the language specified in the context

func (*Translator) TranslateCf 

func (t *Translator) TranslateCf(ctx context.Context, key string, args ...any) string

func (*Translator) TranslateCtx 

func (t *Translator) TranslateCtx(ctx context.Context, key string) string

TranslateCtx is an alias for TranslateC

func (*Translator) Translatef 

func (t *Translator) Translatef(language, key string, args ...any) string

Translatef translates a key into a specific language with optional formatting args

type TranslatorOptions 

type TranslatorOptions struct {
	DefaultLanguage string
	ValidLanguages  []string
}

TranslatorOptions represents Translator options

type Worker 

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

Worker represents an object capable of blocking, handling signals and stopping

func NewWorker 

func NewWorker(o WorkerOptions) (w *Worker)

NewWorker builds a new worker

func (*Worker) Context 

func (w *Worker) Context() context.Context

Context returns the worker's context

func (*Worker) HandleSignals 

func (w *Worker) HandleSignals(hs ...SignalHandler)

HandleSignals handles signals

func (*Worker) Logger 

func (w *Worker) Logger() SeverityLogger

Logger returns the worker's logger

func (*Worker) NewTask 

func (w *Worker) NewTask() *Task

NewTask creates a new task

func (*Worker) Stop 

func (w *Worker) Stop()

Stop stops the Worker

func (*Worker) Wait 

func (w *Worker) Wait()

Wait is a blocking pattern

type WorkerOptions 

type WorkerOptions struct {
	Logger StdLogger
}

WorkerOptions represents worker options

type WriterAdapter 

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

WriterAdapter represents an object that can adapt a Writer

func NewWriterAdapter 

func NewWriterAdapter(o WriterAdapterOptions) *WriterAdapter

NewWriterAdapter creates a new WriterAdapter

func (*WriterAdapter) Close 

func (w *WriterAdapter) Close() error

Close closes the adapter properly

func (*WriterAdapter) Write 

func (w *WriterAdapter) Write(i []byte) (n int, err error)

Write implements the io.Writer interface

type WriterAdapterOptions 

type WriterAdapterOptions struct {
	Callback func(i []byte)
	Split    []byte
}

WriterAdapterOptions represents WriterAdapter options

Source Files

View all Source files

Directories

Path Synopsis
ipc
posix
systemv

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.
JackTT - Gopher 🇻🇳