package xxhash

Import Path
	github.com/cespare/xxhash/v2 (on go.dev)

Dependency Relation
	imports 4 packages, and imported by 3 packages

Involved Source Files

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

	    xxhash_asm.go
	    xxhash_unsafe.go
	    xxhash_amd64.s
Package-Level Type Names (only one)

	/* sort by: alphabet | popularity */
	 type Digest (struct)
		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.

		Methods (total 10)
			(*Digest) BlockSize() int
				BlockSize always returns 32 bytes.

			(*Digest) MarshalBinary() ([]byte, error)
				MarshalBinary implements the encoding.BinaryMarshaler interface.

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

			(*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.

			(*Digest) Size() int
				Size always returns 8 bytes.

			(*Digest) Sum(b []byte) []byte
				Sum appends the current hash to b and returns the resulting slice.

			(*Digest) Sum64() uint64
				Sum64 returns the current hash.

			(*Digest) UnmarshalBinary(b []byte) error
				UnmarshalBinary implements the encoding.BinaryUnmarshaler interface.

			(*Digest) Write(b []byte) (n int, err error)
				Write adds more data to d. It always returns len(b), nil.

			(*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.

		Implements (at least 9)
			*Digest : github.com/gogo/protobuf/proto.Sizer
			*Digest : github.com/miekg/dns.Writer
			*Digest : encoding.BinaryMarshaler
			*Digest : encoding.BinaryUnmarshaler
			*Digest : hash.Hash
			*Digest : hash.Hash64
			*Digest : internal/bisect.Writer
			*Digest : io.StringWriter
			*Digest : io.Writer
		As Outputs Of (at least 2)
			func New() *Digest
			func NewWithSeed(seed uint64) *Digest


Package-Level Functions (total 4)

	 func New() *Digest
		New creates a new Digest with a zero seed.

	 func NewWithSeed(seed uint64) *Digest
		NewWithSeed creates a new Digest with the given seed.

	 func Sum64(b []byte) uint64
		Sum64 computes the 64-bit xxHash digest of b with a zero seed.

	 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.

The pages are generated with Golds v0.8.2. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.