Affected by 
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 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 TildeExpansion(filename string) (string, error)
- func XOR(a, b []byte) []byte
- type MultiErr
Constants ¶
This section is empty.
Variables ¶
var Debug bool
Debug is a global flag for debugging.
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 TimeFormatIpfs = time.RFC3339Nano
Functions ¶
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 NewSeededRand ¶
func NewSeededRand(seed int64) io.Reader
func NewTimeSeededRand ¶
func NewTimeSeededRand() io.Reader
func ParseRFC3339 ¶
func ParseRFC3339(s string) (time.Time, error)
func RPartition ¶
func RPartition(subject string, sep string) (string, string, string)
func TildeExpansion ¶
func TildeExpansion(filename string) (string, error)
TildeExpansion expands a filename, which may begin with a tilde.
Types ¶
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
eventlog
|
|
|
loggables
Package loggables includes a bunch of transaltor functions for commonplace/stdlib objects.
|
Package loggables includes a bunch of transaltor functions for commonplace/stdlib objects. |
|
ci
Package ci implements some helper functions to use during tests.
|
Package ci implements some helper functions to use during tests. |
|
ci/travis
Package travis implements some helper functions to use during tests.
|
Package travis implements some helper functions to use during tests. |