common

Documentation

Index

• Constants
• func FetchHTTPContent(target string) ([]byte, error)
• func GetAssetLocation(file string) string
• func GetProgramDir() string
• func HumanFriendlyTraffic(bytes uint64) string
• func Must(err error)
• func Must2(_ any, err error)
• func PickPort(network string, host string) int
• func SHA224String(password string) string
• func WriteAllBytes(writer io.Writer, payload []byte) error
• func WriteFile(path string, payload []byte) error
• type Error
  • func NewError(info string) *Error
  • func NewErrorf(format string, a ...any) *Error
  • func (e *Error) Base(err error) *Error
  • func (e *Error) Error() string
• type Notifier
  • func NewNotifier() *Notifier
  • func (n *Notifier) Signal()
  • func (n *Notifier) Wait() <-chan struct{}
• type RewindConn
  • func NewRewindConn(conn net.Conn) *RewindConn
  • func (c *RewindConn) Read(p []byte) (int, error)
• type RewindReader
  • func (r *RewindReader) Discard(n int) (int, error)
  • func (r *RewindReader) Read(p []byte) (int, error)
  • func (r *RewindReader) ReadByte() (byte, error)
  • func (r *RewindReader) Rewind()
  • func (r *RewindReader) SetBufferSize(size int)
  • func (r *RewindReader) StopBuffering()
• type Runnable
• type StickyWriter
  • func (w *StickyWriter) Write(p []byte) (int, error)

Constants

const (
	KiB = 1024
	MiB = KiB * 1024
	GiB = MiB * 1024
)

Functions

func FetchHTTPContent

func FetchHTTPContent(target string) ([]byte, error)

func GetAssetLocation

func GetAssetLocation(file string) string

func GetProgramDir

func GetProgramDir() string

func HumanFriendlyTraffic

func HumanFriendlyTraffic(bytes uint64) string

func Must

func Must(err error)

func Must2

func Must2(_ any, err error)

func PickPort

func PickPort(network string, host string) int

func SHA224String

func SHA224String(password string) string

func WriteAllBytes

func WriteAllBytes(writer io.Writer, payload []byte) error

func WriteFile

func WriteFile(path string, payload []byte) error

Types

type Error

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

func NewError

func NewError(info string) *Error

func NewErrorf

func NewErrorf(format string, a ...any) *Error

func (*Error) Base

func (e *Error) Base(err error) *Error

func (*Error) Error

func (e *Error) Error() string

type Notifier

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

Notifier is a utility for notifying changes. The change producer may notify changes multiple time, and the consumer may get notified asynchronously.

func NewNotifier

func NewNotifier() *Notifier

NewNotifier creates a new Notifier.

func (*Notifier) Signal

func (n *Notifier) Signal()

Signal signals a change, usually by producer. This method never blocks.

func (*Notifier) Wait

func (n *Notifier) Wait() <-chan struct{}

Wait returns a channel for waiting for changes. The returned channel never gets closed.

type RewindConn

type RewindConn struct {
	net.Conn
	*RewindReader
}

func NewRewindConn

func NewRewindConn(conn net.Conn) *RewindConn

func (*RewindConn) Read

func (c *RewindConn) Read(p []byte) (int, error)

type RewindReader

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

func (*RewindReader) Discard

func (r *RewindReader) Discard(n int) (int, error)

func (*RewindReader) Read

func (r *RewindReader) Read(p []byte) (int, error)

func (*RewindReader) ReadByte

func (r *RewindReader) ReadByte() (byte, error)

func (*RewindReader) Rewind

func (r *RewindReader) Rewind()

func (*RewindReader) SetBufferSize

func (r *RewindReader) SetBufferSize(size int)

func (*RewindReader) StopBuffering

func (r *RewindReader) StopBuffering()

type Runnable

type Runnable interface {
	Run() error
	Close() error
}

type StickyWriter

type StickyWriter struct {
	MaxBuffered int
	// contains filtered or unexported fields
}

func (*StickyWriter) Write

func (w *StickyWriter) Write(p []byte) (int, error)