tools

package module

v0.0.0-...-033bb3f Latest Latest Go to latest Published: May 3, 2023 License: Apache-2.0 Imports: 17 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/celestiaorg/tools

Links

Open Source Insights

README ¶

tools

A number of frequently used codes. We need to gradually move these codes to the utils repo.

Documentation ¶

Overview ¶

This package contains the tools that frequently used by other packages

Index ¶

func AskForConfirmation(question string) (bool, error)
func GetUserIP(req *http.Request) string
func GrpcConnect(addr string, tlsEnabled bool) (*grpc.ClientConn, error)
func HttpGetReqPersist(url string, opts ...ReqOption) ([]byte, error)
func HttpPostReqPersist(url string, payload io.Reader, opts ...ReqOption) ([]byte, error)
func HttpPutReqPersist(url string, payload io.Reader, opts ...ReqOption) ([]byte, error)
func HttpReqPersist(url string, payload io.Reader, method string, opts ...ReqOption) ([]byte, error)
func IsErrCode(err error, code int) bool
func IsErrNotfound(err error) bool
func IsErrTooManyRequests(err error) bool
func NewError(code int, text string) error
func NewErrorf(code int, format string, a ...interface{}) error
func PrettyPrint(v any, prefix ...string)
func PrintJson(v any, prefix ...string)
func RandomBool(chancePercent int) bool
func RandomNumberF(rangeLower float64, rangeUpper float64) float64
func RandomNumberI(rangeLower int64, rangeUpper int64) int64
func RandomString(length int) string
func ReadAll(rc io.ReadCloser) ([]byte, error)
func UniqueStringSlice(input []string) []string
func WaitCountdown(s time.Duration, msg string)
type ClosingBuffer
- func (cb *ClosingBuffer) Close() error
type CodeError
- func (e CodeError) Error() string
type ReqOption
- func HttpAddHeader(key, value string) ReqOption
- func HttpWithRetry(r uint) ReqOption
- func HttpWithTimeout(t time.Duration) ReqOption

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func AskForConfirmation ¶

func AskForConfirmation(question string) (bool, error)

func GetUserIP ¶

func GetUserIP(req *http.Request) string

func GrpcConnect ¶

func GrpcConnect(addr string, tlsEnabled bool) (*grpc.ClientConn, error)

func HttpGetReqPersist ¶

func HttpGetReqPersist(url string, opts ...ReqOption) ([]byte, error)

func HttpPostReqPersist ¶

func HttpPostReqPersist(url string, payload io.Reader, opts ...ReqOption) ([]byte, error)

func HttpPutReqPersist ¶

func HttpPutReqPersist(url string, payload io.Reader, opts ...ReqOption) ([]byte, error)

func HttpReqPersist ¶

func HttpReqPersist(url string, payload io.Reader, method string, opts ...ReqOption) ([]byte, error)

func IsErrCode ¶

func IsErrCode(err error, code int) bool

func IsErrNotfound ¶

func IsErrNotfound(err error) bool

func IsErrTooManyRequests ¶

func IsErrTooManyRequests(err error) bool

func NewError ¶

func NewError(code int, text string) error

func NewErrorf ¶

func NewErrorf(code int, format string, a ...interface{}) error

func PrettyPrint ¶

func PrettyPrint(v any, prefix ...string)

useful for debugging

func PrintJson ¶

func PrintJson(v any, prefix ...string)

func RandomBool ¶

func RandomBool(chancePercent int) bool

It generates a random boolean status the `chancePercent` should be between 0 and 100

func RandomNumberF ¶

func RandomNumberF(rangeLower float64, rangeUpper float64) float64

This function receives a pair of min and max float64 numbers and generates a random number in that range (inclusive)

func RandomNumberI ¶

func RandomNumberI(rangeLower int64, rangeUpper int64) int64

This function receives a pair of min and max int64 numbers and generates a random number in that range (inclusive)

func RandomString ¶

func RandomString(length int) string

This function receives the length of a string and generates a random string

func ReadAll ¶

func ReadAll(rc io.ReadCloser) ([]byte, error)

func UniqueStringSlice ¶

func UniqueStringSlice(input []string) []string

func WaitCountdown ¶

func WaitCountdown(s time.Duration, msg string)

Types ¶

type ClosingBuffer ¶

type ClosingBuffer struct {
	*bytes.Buffer
}

func (*ClosingBuffer) Close ¶

func (cb *ClosingBuffer) Close() error

type CodeError ¶

type CodeError struct {
	Code int
	Text string
}

CodeError is a error with a code (like 404 Not Found).

func (CodeError) Error ¶

func (e CodeError) Error() string

type ReqOption ¶

type ReqOption interface {
	// contains filtered or unexported methods
}

func HttpAddHeader ¶

func HttpAddHeader(key, value string) ReqOption

func HttpWithRetry ¶

func HttpWithRetry(r uint) ReqOption

func HttpWithTimeout ¶

func HttpWithTimeout(t time.Duration) ReqOption

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
cache
progressbar
syncprogress

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL