Documentation
¶
Index ¶
- func CopyDir(src string, dst string) error
- func CopyFile(src, dst string) (int64, error)
- func CreateShutdownChannel() chan os.Signal
- func Exists(fn string) bool
- func GetFreePort() (port int, err error)
- func GzipFile(filepath string) error
- func IsLocalhost(url string) bool
- func IsRunningInsideContainer() bool
- func IsRunningInsideDocker() bool
- func ListDir(dir string) ([]string, error)
- func LocalIP() (string, error)
- func ProcessDirWithDecoder(dir string, callback ProcessDirWithDecoderCallback) error
- func Ptr[T any](v T) *T
- func RecoverPanic(logger logger.Logger)
- func TarGz(srcDir string, outfile *os.File) error
- func Unzip(src, dest string, flatten bool) error
- func WriteJSON(filename string, v any) error
- func WriteJSONLAppend(filename string, v []interface{}) error
- type JSONDecoder
- type JSONEncoder
- type ProcessDirWithDecoderCallback
- type Result
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CreateShutdownChannel ¶
CreateShutdownChannel returns a channel which can be used to block for a termination signal (SIGTERM, SIGINT, etc)
func GetFreePort ¶
GetFreePort asks the kernel for a free open port that is ready to use.
func IsLocalhost ¶
IsLocalhost returns true if the input points to localhost/loopback or an unspecified address.
func IsRunningInsideContainer ¶ added in v1.0.110
func IsRunningInsideContainer() bool
IsRunningInsideContainer returns true if the process is running inside a container environment.
func IsRunningInsideDocker ¶
func IsRunningInsideDocker() bool
IsRunningInsideDocker returns true if the process is running inside a container environment. WARNING: This function is deprecated and will be removed in a future release.
func ProcessDirWithDecoder ¶
func ProcessDirWithDecoder(dir string, callback ProcessDirWithDecoderCallback) error
ProcessDirWithDecoder will process all the JSON files in directory and call the callback
func RecoverPanic ¶
RecoverPanic recovers from a panic and logs the error along with the current goroutines.
func WriteJSONLAppend ¶
Types ¶
type JSONDecoder ¶
type JSONDecoder interface {
Decode(v any) error
// More returns true if there are more items in the stream
More() bool
// Count returns the number of records read
Count() int
// Close a stream
Close() error
}
func NewNDJSONDecoder ¶
func NewNDJSONDecoder(fn string) (JSONDecoder, error)
NewNDJSONDecoder returns a decoder which can be used to read JSON new line delimited files
type JSONEncoder ¶
type JSONEncoder interface {
// Encode will encode v as a new line delimited JSON encoded string
Encode(v any) error
// Close a stream
Close() error
// Count returns the number of records written
Count() int
}
JSONEncoder is an encoder that will allow you to encode one or more objects as JSON newline delimited output
func NewNDJSONEncoder ¶
func NewNDJSONEncoder(fn string) (JSONEncoder, error)
NewNDJSONEncoder will return a JSONEncoder which allows you to stream json as new line delimited JSON
func NewNDJSONEncoderAppend ¶
func NewNDJSONEncoderAppend(fn string) (JSONEncoder, error)
type ProcessDirWithDecoderCallback ¶
type ProcessDirWithDecoderCallback func(decoder JSONDecoder, filename string) error
type Result ¶ added in v1.0.79
Result represents a value that can be either successful (Ok) or an error (Err), similar to Rust's Result type.
func (Result[T]) IsErrMatches ¶ added in v1.0.79
IsErrMatches returns true if the Result contains an error containing any of the given string values.
Source Files