hash

README

go-whosonfirst-hash

Go package for working with hashes in Who's On First documents

Install

You will need to have both Go (specifically version 1.12 or higher because we're using Go modules) and the make programs installed on your computer. Assuming you do just type:

make tools

All of this package's dependencies are bundled with the code in the vendor directory.

Important

This is almost certainly not a general purpose package. It is shaped like the day-to-day needs of Who's On First in mid-2017...

Documentation

Index

• type Hash
  • func NewHash(algo string) (*Hash, error)
  • func NewWOFHash() (*Hash, error)
  • func (h *Hash) HashBytes(body []byte) (string, error)
  • func (h *Hash) HashFile(path string) (string, error)
  • func (h *Hash) HashFromJSON(raw []byte) (string, error)
  • func (h *Hash) HashString(body string) (string, error)

Types

type Hash

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

func NewHash

func NewHash(algo string) (*Hash, error)

func NewWOFHash

func NewWOFHash() (*Hash, error)

func (*Hash) HashBytes

func (h *Hash) HashBytes(body []byte) (string, error)

func (*Hash) HashFile

func (h *Hash) HashFile(path string) (string, error)

func (*Hash) HashFromJSON

func (h *Hash) HashFromJSON(raw []byte) (string, error)

func (*Hash) HashString

func (h *Hash) HashString(body string) (string, error)