xxh32

Documentation

Overview

Package xxh32 implements the very fast XXH hashing algorithm (32 bits version). (https://github.com/Cyan4973/XXH/)

Package xxh32 implements the very fast XXH hashing algorithm (32 bits version). (https://github.com/Cyan4973/XXH/)

Index

• func Checksum(input []byte, seed uint32) uint32
• func ChecksumZero(input []byte) uint32
• func Uint32(x, seed uint32) uint32
• func Uint32Zero(x uint32) uint32
• type XXH
  • func (xxh *XXH) BlockSize() int
  • func (xxh *XXH) Init(seed uint32)
  • func (xxh *XXH) Reset()
  • func (xxh *XXH) Size() int
  • func (xxh XXH) Sum(b []byte) []byte
  • func (xxh *XXH) Sum32() uint32
  • func (xxh *XXH) Write(input []byte) (int, error)
• type XXHZero
  • func (xxh *XXHZero) BlockSize() int
  • func (xxh *XXHZero) Reset()
  • func (xxh *XXHZero) Size() int
  • func (xxh XXHZero) Sum(b []byte) []byte
  • func (xxh *XXHZero) Sum32() uint32
  • func (xxh *XXHZero) Write(input []byte) (int, error)

Functions

func Checksum

func Checksum(input []byte, seed uint32) uint32

Checksum returns the 32bits Hash value.

func ChecksumZero

func ChecksumZero(input []byte) uint32

ChecksumZero returns the 32bits Hash value.

func Uint32

func Uint32(x, seed uint32) uint32

Uint32 hashes x with the given seed.

func Uint32Zero

func Uint32Zero(x uint32) uint32

Uint32Zero hashes x with seed 0.

Types

type XXH

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

XXH represents an xxhash32 object.

func (*XXH) BlockSize

func (xxh *XXH) BlockSize() int

BlockSize gives the minimum number of bytes accepted by Write().

func (*XXH) Init

func (xxh *XXH) Init(seed uint32)

Init sets the seed and Reset().

func (*XXH) Reset

func (xxh *XXH) Reset()

Reset resets the Hash to its initial state.

func (*XXH) Size

func (xxh *XXH) Size() int

Size returns the number of bytes returned by Sum().

func (XXH) Sum

func (xxh XXH) Sum(b []byte) []byte

Sum appends the current hash to b and returns the resulting slice. It does not change the underlying hash state.

func (*XXH) Sum32

func (xxh *XXH) Sum32() uint32

Sum32 returns the 32 bits Hash value.

func (*XXH) Write

func (xxh *XXH) Write(input []byte) (int, error)

Write adds input bytes to the Hash. It never returns an error.

type XXHZero

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

XXHZero represents an xxhash32 object with seed 0.

func (*XXHZero) BlockSize

func (xxh *XXHZero) BlockSize() int

BlockSize gives the minimum number of bytes accepted by Write().

func (*XXHZero) Reset

func (xxh *XXHZero) Reset()

Reset resets the Hash to its initial state.

func (*XXHZero) Size

func (xxh *XXHZero) Size() int

Size returns the number of bytes returned by Sum().

func (XXHZero) Sum

func (xxh XXHZero) Sum(b []byte) []byte

Sum appends the current hash to b and returns the resulting slice. It does not change the underlying hash state.

func (*XXHZero) Sum32

func (xxh *XXHZero) Sum32() uint32

Sum32 returns the 32 bits Hash value.

func (*XXHZero) Write

func (xxh *XXHZero) Write(input []byte) (int, error)

Write adds input bytes to the Hash. It never returns an error.