util

Documentation

Overview

Package util implements various utility functions used within ipfs that do not currently have a better place to live.

Index

• Variables
• func ContextDo(ctx context.Context, f func() error) error
• func ContextWithErrorLog(parent context.Context) (context.Context, <-chan error)
• func ErrCast() error
• func ExpandPathnames(paths []string) ([]string, error)
• func FileExists(filename string) bool
• func FormatRFC3339(t time.Time) string
• func GetenvBool(name string) bool
• func Hash(data []byte) mh.Multihash
• func IsValidHash(s string) bool
• func LogError(ctx context.Context, err error)
• func Logger(name string) *logrus.Entry
• func NewSeededRand(seed int64) io.Reader
• func NewTimeSeededRand() io.Reader
• func ParseRFC3339(s string) (time.Time, error)
• func Partition(subject string, sep string) (string, string, string)
• func RPartition(subject string, sep string) (string, string, string)
• func SetAllLoggers(lvl logrus.Level)
• func SetDebugLogging()
• func SetLogLevel(name, level string) error
• func SetupLogging()
• func TildeExpansion(filename string) (string, error)
• func XOR(a, b []byte) []byte
• type MultiErr
  • func (m MultiErr) Error() string

Variables

var Debug bool

Debug is a global flag for debugging.

var ErrNoSuchLogger = errors.New("Error: No such logger")

ErrNoSuchLogger is returned when the util pkg is asked for a non existant logger

var ErrNotFound = ds.ErrNotFound

ErrNotFound is returned when a search fails to find anything

var ErrNotImplemented = errors.New("Error: not implemented yet.")

ErrNotImplemented signifies a function has not been implemented yet.

var ErrSearchIncomplete = errors.New("Error: Search Incomplete.")

ErrSeErrSearchIncomplete implies that a search type operation didnt find the expected node, but did find 'a' node.

var ErrTimeout = errors.New("Error: Call timed out.")

ErrTimeout implies that a timeout has been triggered

var LogFormats = map[string]*logrus.TextFormatter{
	"nocolor": &logrus.TextFormatter{DisableColors: true, FullTimestamp: true, TimestampFormat: "2006-01-02 15:04:05.000000", DisableSorting: true},
	"color":   &logrus.TextFormatter{DisableColors: false, FullTimestamp: true, TimestampFormat: "15:04:05:000", DisableSorting: true},
}

LogFormats is a map of formats used for our logger, keyed by name. TODO: write custom TextFormatter (don't print module=name explicitly) and fork logrus to add shortfile

var TimeFormatIpfs = time.RFC3339Nano

Functions

func ContextDo

func ContextDo(ctx context.Context, f func() error) error

func ContextWithErrorLog

func ContextWithErrorLog(parent context.Context) (context.Context, <-chan error)

ContextWithErrorLog returns a copy of parent and an error channel that can be used to receive errors sent with the LogError method.

func ErrCast

func ErrCast() error

ErrCast is returned when a cast fails AND the program should not panic.

func ExpandPathnames

func ExpandPathnames(paths []string) ([]string, error)

ExpandPathnames takes a set of paths and turns them into absolute paths

func FileExists

func FileExists(filename string) bool

func FormatRFC3339

func FormatRFC3339(t time.Time) string

func GetenvBool

func GetenvBool(name string) bool

GetenvBool is the way to check an env var as a boolean

func Hash

func Hash(data []byte) mh.Multihash

Hash is the global IPFS hash function. uses multihash SHA2_256, 256 bits

func IsValidHash

func IsValidHash(s string) bool

IsValidHash checks whether a given hash is valid (b58 decodable, len > 0)

func LogError

func LogError(ctx context.Context, err error)

LogError logs the error to the owner of the context.

If this context was created with ContextWithErrorLog, then this method passes the error to context creator over an unbuffered channel.

If this context was created by other means, this method is a no-op.

func Logger

func Logger(name string) *logrus.Entry

Logger retrieves a particular logger

func NewSeededRand

func NewSeededRand(seed int64) io.Reader

func NewTimeSeededRand

func NewTimeSeededRand() io.Reader

func ParseRFC3339

func ParseRFC3339(s string) (time.Time, error)

func Partition

func Partition(subject string, sep string) (string, string, string)

func RPartition

func RPartition(subject string, sep string) (string, string, string)

func SetAllLoggers

func SetAllLoggers(lvl logrus.Level)

SetAllLoggers changes the logrus.Level of all loggers to lvl

func SetDebugLogging

func SetDebugLogging()

SetDebugLogging calls SetAllLoggers with logrus.DebugLevel

func SetLogLevel

func SetLogLevel(name, level string) error

SetLogLevel changes the log level of a specific subsystem name=="*" changes all subsystems

func SetupLogging

func SetupLogging()

SetupLogging will initialize the logger backend and set the flags.

func TildeExpansion

func TildeExpansion(filename string) (string, error)

TildeExpansion expands a filename, which may begin with a tilde.

func XOR

func XOR(a, b []byte) []byte

XOR takes two byte slices, XORs them together, returns the resulting slice.

Types

type MultiErr

type MultiErr []error

MultiErr is a util to return multiple errors

func (MultiErr) Error

func (m MultiErr) Error() string