util

README

go-ipfs-util

Common utilities used by go-ipfs and other related go packages

Install

Usage

Contribute

Feel free to join in. All welcome. Open an issue!

This repository falls under the IPFS Code of Conduct.

Want to hack on IPFS?

License

MIT

Documentation

Overview

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

Index

• Constants
• Variables
• 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 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 XOR(a, b []byte) []byte
• type MultiErr
  • func (m MultiErr) Error() string

Constants

const DefaultIpfsHash = mh.SHA2_256

DefaultIpfsHash is the current default hash function used by IPFS.

Variables

var Debug bool

Debug is a global flag for debugging.

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 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 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 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