fingerprint

Documentation

Index

• func Fingerprint(val Hashable) (string, error)
• func Map[K comparable, V any, H Hashable](m map[K]V, fn func(K, V) (string, H)) mapped[H]
• type Bool
  • func (b Bool) Hash(h *Hasher) error
• type Hashable
• type Hasher
  • func New() *Hasher
  • func (h *Hasher) Close()
  • func (h *Hasher) Finish() string
  • func (h *Hasher) Named(name string, vals ...Hashable) error
• type Int
  • func (i Int) Hash(h *Hasher) error
• type List
  • func Cast[E any, T ~[]E, H Hashable](slice T, fn func(E) H) List[H]
  • func (l List[T]) Hash(h *Hasher) error
• type String
  • func (s String) Hash(h *Hasher) error

Functions

func Fingerprint

func Fingerprint(val Hashable) (string, error)

Fingerprint is a short-hand for creating a new Hasher, calling [Hashable.Hash] on the provided value (unless it is nil), and then returning the Hasher.Finish result.

func Map

func Map[K comparable, V any, H Hashable](m map[K]V, fn func(K, V) (string, H)) mapped[H]

Types

type Bool

type Bool bool

func (Bool) Hash

func (b Bool) Hash(h *Hasher) error

type Hashable

type Hashable interface {
	Hash(h *Hasher) error
}

type Hasher

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

func New

func New() *Hasher

New returns a Hasher from the pool, ready to use.

func (*Hasher) Close

func (h *Hasher) Close()

Close returns this Hasher to the pool.

func (*Hasher) Finish

func (h *Hasher) Finish() string

Finish obtains this Hasher's current fingerprint. It does not change the underlying state of the Hasher.

func (*Hasher) Named

func (h *Hasher) Named(name string, vals ...Hashable) error

Named hashes a named list of values. This creates explicit grouping of the values, avoiding that the concatenation of two things has a different hash than those same two things one after the other.

type Int

type Int int

func (Int) Hash

func (i Int) Hash(h *Hasher) error

type List

type List[T Hashable] []T

func Cast

func Cast[E any, T ~[]E, H Hashable](slice T, fn func(E) H) List[H]

func (List[T]) Hash

func (l List[T]) Hash(h *Hasher) error

type String

type String string

func (String) Hash

func (s String) Hash(h *Hasher) error