hash

Documentation

Index

• Variables
• type Digest
  • func New() *Digest
  • func (d *Digest) Sum(b []byte) Hash
  • func (d *Digest) WriteObject(v interface{}) (int, error)
• type Hash
  • func Decode(h string) (Hash, error)
  • func DecodeFromBytes(data []byte) (Hash, error)
  • func Dump(v interface{}) Hash
  • func Int(h int) Hash
  • func Random() (Hash, error)
  • func (h Hash) Equal(h1 Hash) bool
  • func (h Hash) IsZero() bool
  • func (h Hash) MarshalJSON() ([]byte, error)
  • func (h Hash) String() string
  • func (h *Hash) UnmarshalJSON(data []byte) error
  • func (h Hash) Valid() bool

Variables

var DefaultHash = sha256.New

DefaultHash is a default hashing algorithm - "sha256".

Types

type Digest

type Digest struct {
	hash.Hash
}

Digest represents the partial evaluation of a checksum.

func New

func New() *Digest

New returns new hash from a given integer.

func (*Digest) Sum

func (d *Digest) Sum(b []byte) Hash

Sum appends the current checksum to b and returns the Hash.

func (*Digest) WriteObject

func (d *Digest) WriteObject(v interface{}) (int, error)

WriteObject adds an interface data to the running hash. It never retruns an error.

type Hash

type Hash []byte

A Hash is a type for representing common hash.

func Decode

func Decode(h string) (Hash, error)

Decode decodes the base58 encoded hash. It returns error when a hash isn't base58,encoded or hash length is invalid.

func DecodeFromBytes

func DecodeFromBytes(data []byte) (Hash, error)

DecodeFromBytes decodes hash and checks it length. It returns empty hash on nil slice of bytes.

func Dump

func Dump(v interface{}) Hash

Dump takes an interface and returns its hash representation.

func Int

func Int(h int) Hash

Int returns a new hash from a given integer. NOTE: This method is for tests purpose only.

func Random

func Random() (Hash, error)

Random returns a new random hash.

func (Hash) Equal

func (h Hash) Equal(h1 Hash) bool

Equal returns a boolean reporting whether h and h1 are the same hashes.

func (Hash) IsZero

func (h Hash) IsZero() bool

IsZero reports whethere h represents empty hash.

func (Hash) MarshalJSON

func (h Hash) MarshalJSON() ([]byte, error)

MarshalJSON mashals hash into encoded json string.

func (Hash) String

func (h Hash) String() string

String returns the hash hex representation.

func (*Hash) UnmarshalJSON

func (h *Hash) UnmarshalJSON(data []byte) error

UnmarshalJSON unmashals hex encoded json string into hash.

func (Hash) Valid

func (h Hash) Valid() bool

Valid checks if service hash length is valid. It treats empty hash as valid one.