package xxhash

import "github.com/cespare/xxhash/v2"

Package xxhash implements the 64-bit variant of xxHash (XXH64) as described at http://cyan4973.github.io/xxHash/.

Index ¶

• func Sum64(b []byte) uint64
• func Sum64String(s string) uint64
• type Digest
• func New() *Digest
• func NewWithSeed(seed uint64) *Digest
• func (d *Digest) BlockSize() int
• func (d *Digest) MarshalBinary() ([]byte, error)
• func (d *Digest) Reset()
• func (d *Digest) ResetWithSeed(seed uint64)
• func (d *Digest) Size() int
• func (d *Digest) Sum(b []byte) []byte
• func (d *Digest) Sum64() uint64
• func (d *Digest) UnmarshalBinary(b []byte) error
• func (d *Digest) Write(b []byte) (n int, err error)
• func (d *Digest) WriteString(s string) (n int, err error)

Functions ¶

func Sum64 ¶

func Sum64(b []byte) uint64

Sum64 computes the 64-bit xxHash digest of b with a zero seed.

func Sum64String ¶

func Sum64String(s string) uint64

Sum64String computes the 64-bit xxHash digest of s with a zero seed. It may be faster than Sum64([]byte(s)) by avoiding a copy.

Types ¶

type Digest ¶

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

Digest implements hash.Hash64.

Note that a zero-valued Digest is not ready to receive writes. Call Reset or create a Digest using New before calling other methods.

func New ¶

func New() *Digest

New creates a new Digest with a zero seed.

func NewWithSeed ¶

func NewWithSeed(seed uint64) *Digest

NewWithSeed creates a new Digest with the given seed.

func (*Digest) BlockSize ¶

func (d *Digest) BlockSize() int

BlockSize always returns 32 bytes.

func (*Digest) MarshalBinary ¶

func (d *Digest) MarshalBinary() ([]byte, error)

MarshalBinary implements the encoding.BinaryMarshaler interface.

func (*Digest) Reset ¶

func (d *Digest) Reset()

Reset clears the Digest's state so that it can be reused. It uses a seed value of zero.

func (*Digest) ResetWithSeed ¶

func (d *Digest) ResetWithSeed(seed uint64)

ResetWithSeed clears the Digest's state so that it can be reused. It uses the given seed to initialize the state.

func (*Digest) Size ¶

func (d *Digest) Size() int

Size always returns 8 bytes.

func (*Digest) Sum ¶

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

Sum appends the current hash to b and returns the resulting slice.

func (*Digest) Sum64 ¶

func (d *Digest) Sum64() uint64

Sum64 returns the current hash.

func (*Digest) UnmarshalBinary ¶

func (d *Digest) UnmarshalBinary(b []byte) error

UnmarshalBinary implements the encoding.BinaryUnmarshaler interface.

func (*Digest) Write ¶

func (d *Digest) Write(b []byte) (n int, err error)

Write adds more data to d. It always returns len(b), nil.

func (*Digest) WriteString ¶

func (d *Digest) WriteString(s string) (n int, err error)

WriteString adds more data to d. It always returns len(s), nil. It may be faster than Write([]byte(s)) by avoiding a copy.

Source Files ¶

xxhash.go xxhash_other.go xxhash_unsafe.go

Directories ¶