package hash

Import Path
	hash (on go.dev)

Dependency Relation
	imports one package, and imported by 9 packages

Involved Source Files

	   #d hash.go
		Package hash provides interfaces for hash functions.
Code Examples

	_binaryMarshaler
		package main
		
		import (
			"bytes"
			"crypto/sha256"
			"encoding"
			"fmt"
			"log"
		)
		
		func main() {
			const (
				input1 = "The tunneling gopher digs downwards, "
				input2 = "unaware of what he will find."
			)
		
			first := sha256.New()
			first.Write([]byte(input1))
		
			marshaler, ok := first.(encoding.BinaryMarshaler)
			if !ok {
				log.Fatal("first does not implement encoding.BinaryMarshaler")
			}
			state, err := marshaler.MarshalBinary()
			if err != nil {
				log.Fatal("unable to marshal hash:", err)
			}
		
			second := sha256.New()
		
			unmarshaler, ok := second.(encoding.BinaryUnmarshaler)
			if !ok {
				log.Fatal("second does not implement encoding.BinaryUnmarshaler")
			}
			if err := unmarshaler.UnmarshalBinary(state); err != nil {
				log.Fatal("unable to unmarshal hash:", err)
			}
		
			first.Write([]byte(input2))
			second.Write([]byte(input2))
		
			fmt.Printf("%x\n", first.Sum(nil))
			fmt.Println(bytes.Equal(first.Sum(nil), second.Sum(nil)))
		}


Package-Level Type Names (total 3, all are exported)

	/* sort exporteds by: alphabet | popularity */
	 type Hash (interface)
		Hash is the common interface implemented by all hash functions.

		Hash implementations in the standard library (e.g. hash/crc32 and
		crypto/sha256) implement the encoding.BinaryMarshaler and
		encoding.BinaryUnmarshaler interfaces. Marshaling a hash implementation
		allows its internal state to be saved and used for additional processing
		later, without having to re-write the data previously written to the hash.
		The hash state may contain portions of the input in its original form,
		which users are expected to handle for any possible security implications.

		Compatibility: Any future changes to hash or crypto packages will endeavor
		to maintain compatibility with state encoded using previous versions.
		That is, any released versions of the packages should be able to
		decode data written with any previously released version,
		subject to issues such as security fixes.
		See the Go compatibility document for background: https://golang.org/doc/go1compat

		Methods (total 5, all are exported)
			( T) BlockSize() int
				BlockSize returns the hash's underlying block size.
				The Write method must be able to accept any amount
				of data, but it may operate more efficiently if all writes
				are a multiple of the block size.

			( T) Reset()
				Reset resets the Hash to its initial state.

			( T) Size() int
				Size returns the number of bytes Sum will return.

			( T) Sum(b []byte) []byte
				Sum appends the current hash to b and returns the resulting slice.
				It does not change the underlying hash state.

			( T) Write(p []byte) (n int, err error)
		Implemented By (at least 9, in which 2 are exported)
			 Hash32 (interface)
			 Hash64 (interface)
			/* 7+ unexporteds ... *//* 7+ unexporteds: */
			*crypto/hmac.hmac
			*crypto/md5.digest
			*crypto/sha1.digest
			*crypto/sha256.digest
			*crypto/sha512.digest
			 crypto/tls.constantTimeHash (interface)
			*crypto/tls.cthWrapper
		Implements (at least one exported)
			 T : io.Writer
		As Outputs Of (at least 13, in which 10 are exported)
			func crypto.Hash.New() Hash
			func crypto/hmac.New(h func() Hash, key []byte) Hash
			func crypto/md5.New() Hash
			func crypto/sha1.New() Hash
			func crypto/sha256.New() Hash
			func crypto/sha256.New224() Hash
			func crypto/sha512.New() Hash
			func crypto/sha512.New384() Hash
			func crypto/sha512.New512_224() Hash
			func crypto/sha512.New512_256() Hash
			/* 3+ unexporteds ... *//* 3+ unexporteds: */
			func crypto/tls.cloneHash(in Hash, h crypto.Hash) Hash
			func crypto/tls.macSHA1(key []byte) Hash
			func crypto/tls.macSHA256(key []byte) Hash
		As Inputs Of (at least 8, in which 2 are exported)
			func crypto/rsa.DecryptOAEP(hash Hash, random io.Reader, priv *rsa.PrivateKey, ciphertext []byte, label []byte) ([]byte, error)
			func crypto/rsa.EncryptOAEP(hash Hash, random io.Reader, pub *rsa.PublicKey, msg []byte, label []byte) ([]byte, error)
			/* 6+ unexporteds ... *//* 6+ unexporteds: */
			func crypto/rsa.emsaPSSEncode(mHash []byte, emBits int, salt []byte, hash Hash) ([]byte, error)
			func crypto/rsa.emsaPSSVerify(mHash, em []byte, emBits, sLen int, hash Hash) error
			func crypto/rsa.mgf1XOR(out []byte, hash Hash, seed []byte)
			func crypto/tls.cloneHash(in Hash, h crypto.Hash) Hash
			func crypto/tls.signedMessage(sigHash crypto.Hash, context string, transcript Hash) []byte
			func crypto/tls.tls10MAC(h Hash, out, seq, header, data, extra []byte) []byte

	 type Hash32 (interface)
		Hash32 is the common interface implemented by all 32-bit hash functions.

		Methods (total 6, all are exported)
			( T) BlockSize() int
				BlockSize returns the hash's underlying block size.
				The Write method must be able to accept any amount
				of data, but it may operate more efficiently if all writes
				are a multiple of the block size.

			( T) Reset()
				Reset resets the Hash to its initial state.

			( T) Size() int
				Size returns the number of bytes Sum will return.

			( T) Sum(b []byte) []byte
				Sum appends the current hash to b and returns the resulting slice.
				It does not change the underlying hash state.

			( T) Sum32() uint32
			( T) Write(p []byte) (n int, err error)
		Implements (at least 2, both are exported)
			 T : Hash
			 T : io.Writer

	 type Hash64 (interface)
		Hash64 is the common interface implemented by all 64-bit hash functions.

		Methods (total 6, all are exported)
			( T) BlockSize() int
				BlockSize returns the hash's underlying block size.
				The Write method must be able to accept any amount
				of data, but it may operate more efficiently if all writes
				are a multiple of the block size.

			( T) Reset()
				Reset resets the Hash to its initial state.

			( T) Size() int
				Size returns the number of bytes Sum will return.

			( T) Sum(b []byte) []byte
				Sum appends the current hash to b and returns the resulting slice.
				It does not change the underlying hash state.

			( T) Sum64() uint64
			( T) Write(p []byte) (n int, err error)
		Implements (at least 2, both are exported)
			 T : Hash
			 T : io.Writer

The pages are generated with Golds v0.4.2. (GOOS=darwin 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 @Go100and1 (reachable from the left QR code) to get the latest news of Golds.