common

package
v0.26.1-rc1 Latest Latest
Warning

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

 Go to latest Published: Nov 7, 2018 License: Apache-2.0, Apache-2.0 Imports: 32 Imported by: 0

Documentation

Overview

nolint

Index

Constants

View Source 
const (
	ANSIReset      = "\x1b[0m"
	ANSIBright     = "\x1b[1m"
	ANSIDim        = "\x1b[2m"
	ANSIUnderscore = "\x1b[4m"
	ANSIBlink      = "\x1b[5m"
	ANSIReverse    = "\x1b[7m"
	ANSIHidden     = "\x1b[8m"

	ANSIFgBlack   = "\x1b[30m"
	ANSIFgRed     = "\x1b[31m"
	ANSIFgGreen   = "\x1b[32m"
	ANSIFgYellow  = "\x1b[33m"
	ANSIFgBlue    = "\x1b[34m"
	ANSIFgMagenta = "\x1b[35m"
	ANSIFgCyan    = "\x1b[36m"
	ANSIFgWhite   = "\x1b[37m"

	ANSIBgBlack   = "\x1b[40m"
	ANSIBgRed     = "\x1b[41m"
	ANSIBgGreen   = "\x1b[42m"
	ANSIBgYellow  = "\x1b[43m"
	ANSIBgBlue    = "\x1b[44m"
	ANSIBgMagenta = "\x1b[45m"
	ANSIBgCyan    = "\x1b[46m"
	ANSIBgWhite   = "\x1b[47m"
)

Variables

View Source 
var (
	// ErrAlreadyStarted is returned when somebody tries to start an already
	// running service.
	ErrAlreadyStarted = errors.New("already started")
	// ErrAlreadyStopped is returned when somebody tries to stop an already
	// stopped service (without resetting it).
	ErrAlreadyStopped = errors.New("already stopped")
	// ErrNotStarted is returned when somebody tries to stop a not running
	// service.
	ErrNotStarted = errors.New("not started")
)
View Source 
var (
	ErrInvalidLengthTypes = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowTypes   = fmt.Errorf("proto: integer overflow")
)
View Source 
var TimeLayout = "2006-01-02" //this represents YYYY-MM-DD

TimeLayout helps to parse a date string of the format YYYY-MM-DD 

  Intended to be used with the following function:
	 time.Parse(TimeLayout, date)

Functions

func ASCIITrim 

func ASCIITrim(s string) string

NOTE: Assumes that s is ASCII as per IsASCIIText(), otherwise panics.

func Black 

func Black(args ...interface{}) string

func Blue 

func Blue(args ...interface{}) string

func ColoredBytes 

func ColoredBytes(data []byte, textColor, bytesColor func(...interface{}) string) string

func Connect 

func Connect(protoAddr string) (net.Conn, error)

Connect dials the given address and returns a net.Conn. The protoAddr argument should be prefixed with the protocol, eg. "tcp://127.0.0.1:8080" or "unix:///tmp/test.sock"

func Cyan 

func Cyan(args ...interface{}) string

func EnsureDir 

func EnsureDir(dir string, mode os.FileMode) error

func Exit 

func Exit(s string)

func FileExists 

func FileExists(filePath string) bool

func Fingerprint 

func Fingerprint(slice []byte) []byte

Fingerprint returns the first 6 bytes of a byte slice. If the slice is less than 6 bytes, the fingerprint contains trailing zeroes.

func GoPath 

func GoPath() string

GoPath returns GOPATH env variable value. If it is not set, this function will try to call `go env GOPATH` subcommand.

func Green 

func Green(args ...interface{}) string

func IntInSlice 

func IntInSlice(a int, list []int) bool

IntInSlice returns true if a is found in the list.

func IsASCIIText 

func IsASCIIText(s string) bool

Returns true if s is a non-empty printable non-tab ascii character.

func IsDirEmpty 

func IsDirEmpty(name string) (bool, error)

func IsEmpty 

func IsEmpty(o interface{}) bool

Returns true if it has zero length.

func IsTypedNil 

func IsTypedNil(o interface{}) bool

Go lacks a simple and safe way to see if something is a typed nil. See:

func Kill 

func Kill() error

Kill the running process by sending itself SIGTERM.

func Magenta 

func Magenta(args ...interface{}) string

func MaxInt 

func MaxInt(a, b int) int

func MaxInt64 

func MaxInt64(a, b int64) int64

func MinInt 

func MinInt(a, b int) int

func MinInt64 

func MinInt64(a, b int64) int64

func MustReadFile 

func MustReadFile(filePath string) []byte

func MustWriteFile 

func MustWriteFile(filePath string, contents []byte, mode os.FileMode)

func PanicConsensus 

func PanicConsensus(v interface{})

Indicates a failure of consensus. Someone was malicious or something has gone horribly wrong. These should really boot us into an "emergency-recover" mode XXX DEPRECATED

func PanicCrisis 

func PanicCrisis(v interface{})

A panic here means something has gone horribly wrong, in the form of data corruption or failure of the operating system. In a correct/healthy system, these should never fire. If they do, it's indicative of a much more serious problem. XXX DEPRECATED

func PanicQ 

func PanicQ(v interface{})

For those times when we're not sure if we should panic XXX DEPRECATED

func PanicSanity 

func PanicSanity(v interface{})

A panic resulting from a sanity check means there is a programmer error and some guarantee is not satisfied. XXX DEPRECATED

func ParseDateRange 

func ParseDateRange(dateRange string) (startDate, endDate time.Time, err error)

ParseDateRange parses a date range string of the format start:end 

  where the start and end date are of the format YYYY-MM-DD.
  The parsed dates are time.Time and will return the zero time for
  unbounded dates, ex:
  unbounded start:	:2000-12-31
	 unbounded end: 	2000-12-31:

func Prompt 

func Prompt(prompt string, defaultValue string) (string, error)

func ProtocolAndAddress 

func ProtocolAndAddress(listenAddr string) (string, string)

ProtocolAndAddress splits an address into the protocol and address components. For instance, "tcp://127.0.0.1:8080" will be split into "tcp" and "127.0.0.1:8080". If the address has no protocol prefix, the default is "tcp".

func RandBool 

func RandBool() bool

func RandBytes 

func RandBytes(n int) []byte

func RandFloat32 

func RandFloat32() float32

func RandFloat64 

func RandFloat64() float64

func RandInt 

func RandInt() int

func RandInt16 

func RandInt16() int16

func RandInt31 

func RandInt31() int32

func RandInt31n 

func RandInt31n(n int32) int32

func RandInt32 

func RandInt32() int32

func RandInt63 

func RandInt63() int64

func RandInt63n 

func RandInt63n(n int64) int64

func RandInt64 

func RandInt64() int64

func RandIntn 

func RandIntn(n int) int

func RandPerm 

func RandPerm(n int) []int

func RandStr 

func RandStr(length int) string

func RandTime 

func RandTime() time.Time

func RandUint 

func RandUint() uint

func RandUint16 

func RandUint16() uint16

func RandUint32 

func RandUint32() uint32

func RandUint64 

func RandUint64() uint64

func ReadFile 

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

func Red 

func Red(args ...interface{}) string

func Seed 

func Seed(seed int64)

func SplitAndTrim 

func SplitAndTrim(s, sep, cutset string) []string

SplitAndTrim slices s into all subslices separated by sep and returns a slice of the string s with all leading and trailing Unicode code points contained in cutset removed. If sep is empty, SplitAndTrim splits after each UTF-8 sequence. First part is equivalent to strings.SplitN with a count of -1.

func StringInSlice 

func StringInSlice(a string, list []string) bool

StringInSlice returns true if a is found the list.

func TrapSignal 

func TrapSignal(cb func())

TrapSignal catches the SIGTERM and executes cb function. After that it exits with code 1.

func White 

func White(args ...interface{}) string

func WriteFile 

func WriteFile(filePath string, contents []byte, mode os.FileMode) error

func WriteFileAtomic 

func WriteFileAtomic(filename string, data []byte, perm os.FileMode) (err error)

WriteFileAtomic creates a temporary file with data and provided perm and swaps it atomically with filename if successful.

func Yellow 

func Yellow(args ...interface{}) string

Types

type BaseService 

type BaseService struct {
	Logger log.Logger
	// contains filtered or unexported fields
}

Classical-inheritance-style service declarations. Services can be started, then stopped, then optionally restarted.

Users can override the OnStart/OnStop methods. In the absence of errors, these methods are guaranteed to be called at most once. If OnStart returns an error, service won't be marked as started, so the user can call Start again.

A call to Reset will panic, unless OnReset is overwritten, allowing OnStart/OnStop to be called again.

The caller must ensure that Start and Stop are not called concurrently.

It is ok to call Stop without calling Start first.

Typical usage: 

type FooService struct {
	BaseService
	// private fields
}

func NewFooService() *FooService {
	fs := &FooService{
		// init
	}
	fs.BaseService = *NewBaseService(log, "FooService", fs)
	return fs
}

func (fs *FooService) OnStart() error {
	fs.BaseService.OnStart() // Always call the overridden method.
	// initialize private fields
	// start subroutines, etc.
}

func (fs *FooService) OnStop() error {
	fs.BaseService.OnStop() // Always call the overridden method.
	// close/destroy private fields
	// stop subroutines, etc.
}

func NewBaseService 

func NewBaseService(logger log.Logger, name string, impl Service) *BaseService

NewBaseService creates a new BaseService.

func (*BaseService) IsRunning 

func (bs *BaseService) IsRunning() bool

IsRunning implements Service by returning true or false depending on the service's state.

func (*BaseService) OnReset 

func (bs *BaseService) OnReset() error

OnReset implements Service by panicking.

func (*BaseService) OnStart 

func (bs *BaseService) OnStart() error

OnStart implements Service by doing nothing. NOTE: Do not put anything in here, that way users don't need to call BaseService.OnStart()

func (*BaseService) OnStop 

func (bs *BaseService) OnStop()

OnStop implements Service by doing nothing. NOTE: Do not put anything in here, that way users don't need to call BaseService.OnStop()

func (*BaseService) Quit 

func (bs *BaseService) Quit() <-chan struct{}

Quit Implements Service by returning a quit channel.

func (*BaseService) Reset 

func (bs *BaseService) Reset() error

Reset implements Service by calling OnReset callback (if defined). An error will be returned if the service is running.

func (*BaseService) SetLogger 

func (bs *BaseService) SetLogger(l log.Logger)

SetLogger implements Service by setting a logger.

func (*BaseService) Start 

func (bs *BaseService) Start() error

Start implements Service by calling OnStart (if defined). An error will be returned if the service is already running or stopped. Not to start the stopped service, you need to call Reset.

func (*BaseService) Stop 

func (bs *BaseService) Stop() error

Stop implements Service by calling OnStop (if defined) and closing quit channel. An error will be returned if the service is already stopped.

func (*BaseService) String 

func (bs *BaseService) String() string

String implements Servce by returning a string representation of the service.

func (*BaseService) Wait 

func (bs *BaseService) Wait()

Wait blocks until the service is stopped.

type BitArray 

type BitArray struct {
	Bits  int      `json:"bits"`  // NOTE: persisted via reflect, must be exported
	Elems []uint64 `json:"elems"` // NOTE: persisted via reflect, must be exported
	// contains filtered or unexported fields
}

BitArray is a thread-safe implementation of a bit array.

func NewBitArray 

func NewBitArray(bits int) *BitArray

NewBitArray returns a new bit array. It returns nil if the number of bits is zero.

func (*BitArray) And 

func (bA *BitArray) And(o *BitArray) *BitArray

And returns a bit array resulting from a bitwise AND of the two bit arrays. If the two bit-arrys have different lengths, this truncates the larger of the two bit-arrays from the right. Thus the size of the return value is the minimum of the two provided bit arrays.

func (*BitArray) Bytes 

func (bA *BitArray) Bytes() []byte

Bytes returns the byte representation of the bits within the bitarray.

func (*BitArray) Copy 

func (bA *BitArray) Copy() *BitArray

Copy returns a copy of the provided bit array.

func (*BitArray) GetIndex 

func (bA *BitArray) GetIndex(i int) bool

GetIndex returns the bit at index i within the bit array. The behavior is undefined if i >= bA.Bits

func (*BitArray) IsEmpty 

func (bA *BitArray) IsEmpty() bool

IsEmpty returns true iff all bits in the bit array are 0

func (*BitArray) IsFull 

func (bA *BitArray) IsFull() bool

IsFull returns true iff all bits in the bit array are 1.

func (*BitArray) MarshalJSON 

func (bA *BitArray) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaler interface by marshaling bit array using a custom format: a string of '-' or 'x' where 'x' denotes the 1 bit.

func (*BitArray) Not 

func (bA *BitArray) Not() *BitArray

Not returns a bit array resulting from a bitwise Not of the provided bit array.

func (*BitArray) Or 

func (bA *BitArray) Or(o *BitArray) *BitArray

Or returns a bit array resulting from a bitwise OR of the two bit arrays. If the two bit-arrys have different lengths, Or right-pads the smaller of the two bit-arrays with zeroes. Thus the size of the return value is the maximum of the two provided bit arrays.

func (*BitArray) PickRandom 

func (bA *BitArray) PickRandom() (int, bool)

PickRandom returns a random index for a set bit in the bit array. If there is no such value, it returns 0, false. It uses the global randomness in `random.go` to get this index.

func (*BitArray) SetIndex 

func (bA *BitArray) SetIndex(i int, v bool) bool

SetIndex sets the bit at index i within the bit array. The behavior is undefined if i >= bA.Bits

func (*BitArray) Size 

func (bA *BitArray) Size() int

Size returns the number of bits in the bitarray

func (*BitArray) String 

func (bA *BitArray) String() string

String returns a string representation of BitArray: BA{<bit-string>}, where <bit-string> is a sequence of 'x' (1) and '_' (0). The <bit-string> includes spaces and newlines to help people. For a simple sequence of 'x' and '_' characters with no spaces or newlines, see the MarshalJSON() method. Example: "BA{_x_}" or "nil-BitArray" for nil.

func (*BitArray) StringIndented 

func (bA *BitArray) StringIndented(indent string) string

StringIndented returns the same thing as String(), but applies the indent at every 10th bit, and twice at every 50th bit.

func (*BitArray) Sub 

func (bA *BitArray) Sub(o *BitArray) *BitArray

Sub subtracts the two bit-arrays bitwise, without carrying the bits. Note that carryless subtraction of a - b is (a and not b). The output is the same as bA, regardless of o's size. If bA is longer than o, o is right padded with zeroes

func (*BitArray) UnmarshalJSON 

func (bA *BitArray) UnmarshalJSON(bz []byte) error

UnmarshalJSON implements json.Unmarshaler interface by unmarshaling a custom JSON description.

func (*BitArray) Update 

func (bA *BitArray) Update(o *BitArray)

Update sets the bA's bits to be that of the other bit array. The copying begins from the begin of both bit arrays.

type BufferCloser 

type BufferCloser struct {
	bytes.Buffer
	Closed bool
}

NOTE: Not goroutine safe

func NewBufferCloser 

func NewBufferCloser(buf []byte) *BufferCloser

func (*BufferCloser) Close 

func (bc *BufferCloser) Close() error

func (*BufferCloser) Write 

func (bc *BufferCloser) Write(p []byte) (n int, err error)

func (*BufferCloser) WriteByte 

func (bc *BufferCloser) WriteByte(c byte) error

func (*BufferCloser) WriteRune 

func (bc *BufferCloser) WriteRune(r rune) (n int, err error)

func (*BufferCloser) WriteString 

func (bc *BufferCloser) WriteString(s string) (n int, err error)

type CMap 

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

CMap is a goroutine-safe map

func NewCMap 

func NewCMap() *CMap

func (*CMap) Clear 

func (cm *CMap) Clear()

func (*CMap) Delete 

func (cm *CMap) Delete(key string)

func (*CMap) Get 

func (cm *CMap) Get(key string) interface{}

func (*CMap) Has 

func (cm *CMap) Has(key string) bool

func (*CMap) Keys 

func (cm *CMap) Keys() []string

func (*CMap) Set 

func (cm *CMap) Set(key string, value interface{})

func (*CMap) Size 

func (cm *CMap) Size() int

func (*CMap) Values 

func (cm *CMap) Values() []interface{}

type Comparable 

type Comparable interface {
	Less(o interface{}) bool
}

type Error 

type Error interface {
	Error() string
	Stacktrace() Error
	Trace(offset int, format string, args ...interface{}) Error
	Data() interface{}
}

Usage with arbitrary error data:

```go 

// Error construction
type MyError struct{}
var err1 error = NewErrorWithData(MyError{}, "my message")
...
// Wrapping
var err2 error  = ErrorWrap(err1, "another message")
if (err1 != err2) { panic("should be the same")
...
// Error handling
switch err2.Data().(type){
	case MyError: ...
    default: ...
}

```

func ErrorWrap 

func ErrorWrap(cause interface{}, format string, args ...interface{}) Error

func NewError 

func NewError(format string, args ...interface{}) Error

New Error with formatted message. The Error's Data will be a FmtError type.

func NewErrorWithData 

func NewErrorWithData(data interface{}) Error

New Error with specified data.

type FmtError 

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

FmtError is the data type for NewError() (e.g. NewError().Data().(FmtError)) Theoretically it could be used to switch on the format string.

```go 

// Error construction
var err1 error = NewError("invalid username %v", "BOB")
var err2 error = NewError("another kind of error")
...
// Error handling
switch err1.Data().(cmn.FmtError).Format() {
	case "invalid username %v": ...
	case "another kind of error": ...
    default: ...
}

```

func (FmtError) Error 

func (fe FmtError) Error() string

func (FmtError) Format 

func (fe FmtError) Format() string

func (FmtError) String 

func (fe FmtError) String() string

type Heap 

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

Example usage:

``` h := NewHeap()

h.Push("msg1", 1) h.Push("msg3", 3) h.Push("msg2", 2)

fmt.Println(h.Pop()) // msg1 fmt.Println(h.Pop()) // msg2 fmt.Println(h.Pop()) // msg3 ```

func NewHeap 

func NewHeap() *Heap

func (*Heap) Len 

func (h *Heap) Len() int64

func (*Heap) Peek 

func (h *Heap) Peek() interface{}

func (*Heap) Pop 

func (h *Heap) Pop() interface{}

func (*Heap) Push 

func (h *Heap) Push(value interface{}, priority int)

func (*Heap) PushBytes 

func (h *Heap) PushBytes(value interface{}, priority []byte)

func (*Heap) PushComparable 

func (h *Heap) PushComparable(value interface{}, priority Comparable)

func (*Heap) Update 

func (h *Heap) Update(value interface{}, priority Comparable)

type HexBytes 

type HexBytes []byte

The main purpose of HexBytes is to enable HEX-encoding for json/encoding.

func (HexBytes) Bytes 

func (bz HexBytes) Bytes() []byte

Allow it to fulfill various interfaces in light-client, etc...

func (HexBytes) Format 

func (bz HexBytes) Format(s fmt.State, verb rune)

func (HexBytes) Marshal 

func (bz HexBytes) Marshal() ([]byte, error)

Marshal needed for protobuf compatibility

func (HexBytes) MarshalJSON 

func (bz HexBytes) MarshalJSON() ([]byte, error)

This is the point of Bytes.

func (HexBytes) String 

func (bz HexBytes) String() string

func (*HexBytes) Unmarshal 

func (bz *HexBytes) Unmarshal(data []byte) error

Unmarshal needed for protobuf compatibility

func (*HexBytes) UnmarshalJSON 

func (bz *HexBytes) UnmarshalJSON(data []byte) error

This is the point of Bytes.

type KI64Pair 

type KI64Pair struct {
	Key                  []byte   `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"`
	Value                int64    `protobuf:"varint,2,opt,name=value,proto3" json:"value,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Define these here for compatibility but use libs/common.KI64Pair.

func NewPopulatedKI64Pair 

func NewPopulatedKI64Pair(r randyTypes, easy bool) *KI64Pair

func (*KI64Pair) Descriptor 

func (*KI64Pair) Descriptor() ([]byte, []int)

func (*KI64Pair) Equal 

func (this *KI64Pair) Equal(that interface{}) bool

func (*KI64Pair) GetKey 

func (m *KI64Pair) GetKey() []byte

func (*KI64Pair) GetValue 

func (m *KI64Pair) GetValue() int64

func (*KI64Pair) Marshal 

func (m *KI64Pair) Marshal() (dAtA []byte, err error)

func (*KI64Pair) MarshalTo 

func (m *KI64Pair) MarshalTo(dAtA []byte) (int, error)

func (*KI64Pair) ProtoMessage 

func (*KI64Pair) ProtoMessage()

func (*KI64Pair) Reset 

func (m *KI64Pair) Reset()

func (*KI64Pair) Size 

func (m *KI64Pair) Size() (n int)

func (*KI64Pair) String 

func (m *KI64Pair) String() string

func (*KI64Pair) Unmarshal 

func (m *KI64Pair) Unmarshal(dAtA []byte) error

func (*KI64Pair) XXX_DiscardUnknown 

func (m *KI64Pair) XXX_DiscardUnknown()

func (*KI64Pair) XXX_Marshal 

func (m *KI64Pair) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*KI64Pair) XXX_Merge 

func (dst *KI64Pair) XXX_Merge(src proto.Message)

func (*KI64Pair) XXX_Size 

func (m *KI64Pair) XXX_Size() int

func (*KI64Pair) XXX_Unmarshal 

func (m *KI64Pair) XXX_Unmarshal(b []byte) error

type KI64Pairs 

type KI64Pairs []KI64Pair

func (KI64Pairs) Len 

func (kvs KI64Pairs) Len() int

Sorting

func (KI64Pairs) Less 

func (kvs KI64Pairs) Less(i, j int) bool

func (KI64Pairs) Sort 

func (kvs KI64Pairs) Sort()

func (KI64Pairs) Swap 

func (kvs KI64Pairs) Swap(i, j int)

type KVPair 

type KVPair struct {
	Key                  []byte   `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"`
	Value                []byte   `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Define these here for compatibility but use libs/common.KVPair.

func NewPopulatedKVPair 

func NewPopulatedKVPair(r randyTypes, easy bool) *KVPair

func (*KVPair) Descriptor 

func (*KVPair) Descriptor() ([]byte, []int)

func (*KVPair) Equal 

func (this *KVPair) Equal(that interface{}) bool

func (*KVPair) GetKey 

func (m *KVPair) GetKey() []byte

func (*KVPair) GetValue 

func (m *KVPair) GetValue() []byte

func (*KVPair) Marshal 

func (m *KVPair) Marshal() (dAtA []byte, err error)

func (*KVPair) MarshalTo 

func (m *KVPair) MarshalTo(dAtA []byte) (int, error)

func (*KVPair) ProtoMessage 

func (*KVPair) ProtoMessage()

func (*KVPair) Reset 

func (m *KVPair) Reset()

func (*KVPair) Size 

func (m *KVPair) Size() (n int)

func (*KVPair) String 

func (m *KVPair) String() string

func (*KVPair) Unmarshal 

func (m *KVPair) Unmarshal(dAtA []byte) error

func (*KVPair) XXX_DiscardUnknown 

func (m *KVPair) XXX_DiscardUnknown()

func (*KVPair) XXX_Marshal 

func (m *KVPair) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*KVPair) XXX_Merge 

func (dst *KVPair) XXX_Merge(src proto.Message)

func (*KVPair) XXX_Size 

func (m *KVPair) XXX_Size() int

func (*KVPair) XXX_Unmarshal 

func (m *KVPair) XXX_Unmarshal(b []byte) error

type KVPairs 

type KVPairs []KVPair

func (KVPairs) Len 

func (kvs KVPairs) Len() int

Sorting

func (KVPairs) Less 

func (kvs KVPairs) Less(i, j int) bool

func (KVPairs) Sort 

func (kvs KVPairs) Sort()

func (KVPairs) Swap 

func (kvs KVPairs) Swap(i, j int)

type PrefixedReader 

type PrefixedReader struct {
	Prefix []byte
	// contains filtered or unexported fields
}

func NewPrefixedReader 

func NewPrefixedReader(prefix []byte, reader io.Reader) *PrefixedReader

func (*PrefixedReader) Read 

func (pr *PrefixedReader) Read(p []byte) (n int, err error)

type Rand 

type Rand struct {
	sync.Mutex
	// contains filtered or unexported fields
}

Rand is a prng, that is seeded with OS randomness. The OS randomness is obtained from crypto/rand, however none of the provided methods are suitable for cryptographic usage. They all utilize math/rand's prng internally.

All of the methods here are suitable for concurrent use. This is achieved by using a mutex lock on all of the provided methods.

func NewRand 

func NewRand() *Rand

func (*Rand) Bool 

func (r *Rand) Bool() bool

Bool returns a uniformly random boolean

func (*Rand) Bytes 

func (r *Rand) Bytes(n int) []byte

Bytes returns n random bytes generated from the internal prng.

func (*Rand) Float32 

func (r *Rand) Float32() float32

func (*Rand) Float64 

func (r *Rand) Float64() float64

func (*Rand) Int 

func (r *Rand) Int() int

func (*Rand) Int16 

func (r *Rand) Int16() int16

func (*Rand) Int31 

func (r *Rand) Int31() int32

func (*Rand) Int31n 

func (r *Rand) Int31n(n int32) int32

func (*Rand) Int32 

func (r *Rand) Int32() int32

func (*Rand) Int63 

func (r *Rand) Int63() int64

func (*Rand) Int63n 

func (r *Rand) Int63n(n int64) int64

func (*Rand) Int64 

func (r *Rand) Int64() int64

func (*Rand) Intn 

func (r *Rand) Intn(n int) int

Intn returns, as an int, a uniform pseudo-random number in the range [0, n). It panics if n <= 0.

func (*Rand) Perm 

func (r *Rand) Perm(n int) []int

Perm returns a pseudo-random permutation of n integers in [0, n).

func (*Rand) Seed 

func (r *Rand) Seed(seed int64)

func (*Rand) Str 

func (r *Rand) Str(length int) string

Str constructs a random alphanumeric string of given length.

func (*Rand) Time 

func (r *Rand) Time() time.Time

func (*Rand) Uint 

func (r *Rand) Uint() uint

func (*Rand) Uint16 

func (r *Rand) Uint16() uint16

func (*Rand) Uint32 

func (r *Rand) Uint32() uint32

func (*Rand) Uint64 

func (r *Rand) Uint64() uint64

type RepeatTimer 

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

RepeatTimer repeatedly sends a struct{}{} to `.Chan()` after each `dur` period. (It's good for keeping connections alive.) A RepeatTimer must be stopped, or it will keep a goroutine alive.

func NewRepeatTimer 

func NewRepeatTimer(name string, dur time.Duration) *RepeatTimer

NewRepeatTimer returns a RepeatTimer with a defaultTicker.

func NewRepeatTimerWithTickerMaker 

func NewRepeatTimerWithTickerMaker(name string, dur time.Duration, tm TickerMaker) *RepeatTimer

NewRepeatTimerWithTicker returns a RepeatTimer with the given ticker maker.

func (*RepeatTimer) Chan 

func (t *RepeatTimer) Chan() <-chan time.Time

func (*RepeatTimer) Reset 

func (t *RepeatTimer) Reset()

Wait the duration again before firing.

func (*RepeatTimer) Stop 

func (t *RepeatTimer) Stop()

type Service 

type Service interface {
	// Start the service.
	// If it's already started or stopped, will return an error.
	// If OnStart() returns an error, it's returned by Start()
	Start() error
	OnStart() error

	// Stop the service.
	// If it's already stopped, will return an error.
	// OnStop must never error.
	Stop() error
	OnStop()

	// Reset the service.
	// Panics by default - must be overwritten to enable reset.
	Reset() error
	OnReset() error

	// Return true if the service is running
	IsRunning() bool

	// Quit returns a channel, which is closed once service is stopped.
	Quit() <-chan struct{}

	// String representation of the service
	String() string

	// SetLogger sets a logger.
	SetLogger(log.Logger)
}

Service defines a service that can be started, stopped, and reset.

type Task 

type Task func(i int) (val interface{}, err error, abort bool)

val: the value returned after task execution. err: the error returned during task completion. abort: tells Parallel to return, whether or not all tasks have completed.

type TaskResult 

type TaskResult struct {
	Value interface{}
	Error error
}

type TaskResultCh 

type TaskResultCh <-chan TaskResult

type TaskResultSet 

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

func Parallel 

func Parallel(tasks ...Task) (trs *TaskResultSet, ok bool)

Run tasks in parallel, with ability to abort early. Returns ok=false iff any of the tasks returned abort=true. NOTE: Do not implement quit features here. Instead, provide convenient concurrent quit-like primitives, passed implicitly via Task closures. (e.g. it's not Parallel's concern how you quit/abort your tasks).

func (*TaskResultSet) Channels 

func (trs *TaskResultSet) Channels() []TaskResultCh

func (*TaskResultSet) FirstError 

func (trs *TaskResultSet) FirstError() error

Returns the firstmost (by task index) error as discovered by all previous Reap() calls.

func (*TaskResultSet) FirstValue 

func (trs *TaskResultSet) FirstValue() interface{}

Returns the firstmost (by task index) error as discovered by all previous Reap() calls.

func (*TaskResultSet) LatestResult 

func (trs *TaskResultSet) LatestResult(index int) (TaskResult, bool)

func (*TaskResultSet) Reap 

func (trs *TaskResultSet) Reap() *TaskResultSet

NOTE: Not concurrency safe. Writes results to trs.results without waiting for all tasks to complete.

func (*TaskResultSet) Wait 

func (trs *TaskResultSet) Wait() *TaskResultSet

NOTE: Not concurrency safe. Like Reap() but waits until all tasks have returned or panic'd.

type ThrottleTimer 

type ThrottleTimer struct {
	Name string
	Ch   chan struct{}
	// contains filtered or unexported fields
}

ThrottleTimer fires an event at most "dur" after each .Set() call. If a short burst of .Set() calls happens, ThrottleTimer fires once. If a long continuous burst of .Set() calls happens, ThrottleTimer fires at most once every "dur".

func NewThrottleTimer 

func NewThrottleTimer(name string, dur time.Duration) *ThrottleTimer

func (*ThrottleTimer) Set 

func (t *ThrottleTimer) Set()

func (*ThrottleTimer) Stop 

func (t *ThrottleTimer) Stop() bool

For ease of .Stop()'ing services before .Start()'ing them, we ignore .Stop()'s on nil ThrottleTimers

func (*ThrottleTimer) Unset 

func (t *ThrottleTimer) Unset()

type Ticker 

type Ticker interface {

	// Never changes, never closes.
	Chan() <-chan time.Time

	// Stopping a stopped Ticker will panic.
	Stop()
}

Ticker is a basic ticker interface.

type TickerMaker 

type TickerMaker func(dur time.Duration) Ticker

Used by RepeatTimer the first time, and every time it's Reset() after Stop().

func NewLogicalTickerMaker 

func NewLogicalTickerMaker(source chan time.Time) TickerMaker

Construct a TickerMaker that always uses `source`. It's useful for simulating a deterministic clock.

Source Files

View all Source files

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.