package blake3

Import Path
	lukechampine.com/blake3 (on go.dev)

Dependency Relation
	imports 11 packages, and imported by one package

Involved Source Files

	  d blake3.go
		Package blake3 implements the BLAKE3 cryptographic hash function.
Package-Level Type Names (total 2)

	/* sort by: alphabet | popularity */
	 type Hasher (struct)
		Hasher implements hash.Hash.

		Methods (total 6)
			(*Hasher) BlockSize() int
				BlockSize implements hash.Hash.

			(*Hasher) Reset()
				Reset implements hash.Hash.

			(*Hasher) Size() int
				Size implements hash.Hash.

			(*Hasher) Sum(b []byte) (sum []byte)
				Sum implements hash.Hash.

			(*Hasher) Write(p []byte) (int, error)
				Write implements hash.Hash.

			(*Hasher) XOF() *OutputReader
				XOF returns an OutputReader initialized with the current hash state.

		Implements (at least 5)
			*Hasher : github.com/gogo/protobuf/proto.Sizer
			*Hasher : github.com/miekg/dns.Writer
			*Hasher : hash.Hash
			*Hasher : internal/bisect.Writer
			*Hasher : io.Writer
		As Outputs Of (at least one exported)
			func New(size int, key []byte) *Hasher

	 type OutputReader (struct)
		An OutputReader produces an seekable stream of 2^64 - 1 pseudorandom output
		bytes.

		Methods (total 2)
			(*OutputReader) Read(p []byte) (int, error)
				Read implements io.Reader. Callers may assume that Read returns len(p), nil
				unless the read would extend beyond the end of the stream.

			(*OutputReader) Seek(offset int64, whence int) (int64, error)
				Seek implements io.Seeker.

		Implements (at least 3)
			*OutputReader : io.Reader
			*OutputReader : io.ReadSeeker
			*OutputReader : io.Seeker
		As Outputs Of (at least one exported)
			func (*Hasher).XOF() *OutputReader


Package-Level Functions (total 9)

	 func BaoDecode(dst io.Writer, data, outboard io.Reader, root [32]byte) (bool, error)
		BaoDecode reads content and tree data from the provided reader(s), and
		streams the verified content to dst.
		
		Deprecated: Use bao.Decode instead.

	 func BaoEncode(dst io.WriterAt, data io.Reader, dataLen int64, outboard bool) ([32]byte, error)
		BaoEncode computes the intermediate BLAKE3 tree hashes of data and writes
		them to dst.
		
		Deprecated: Use bao.Encode instead.

	 func BaoEncodeBuf(data []byte, outboard bool) ([]byte, [32]byte)
		BaoEncodeBuf returns the Bao encoding and root (i.e. BLAKE3 hash) for data.
		
		Deprecated: Use bao.EncodeBuf instead.

	 func BaoEncodedSize(dataLen int, outboard bool) int
		EncodedSize returns the size of a Bao encoding for the provided quantity
		of data.
		
		Deprecated: Use bao.EncodedSize instead.

	 func BaoVerifyBuf(data, outboard []byte, root [32]byte) bool
		BaoVerifyBuf verifies the Bao encoding and root (i.e. BLAKE3 hash) for data.
		
		Deprecated: Use bao.VerifyBuf instead.

	 func DeriveKey(subKey []byte, ctx string, srcKey []byte)
		DeriveKey derives a subkey from ctx and srcKey. ctx should be hardcoded,
		globally unique, and application-specific. A good format for ctx strings is:
		
			[application] [commit timestamp] [purpose]
		
		e.g.:
		
			example.com 2019-12-25 16:18:03 session tokens v1
		
		The purpose of these requirements is to ensure that an attacker cannot trick
		two different applications into using the same context string.

	 func New(size int, key []byte) *Hasher
		New returns a Hasher for the specified digest size and key. If key is nil,
		the hash is unkeyed. Otherwise, len(key) must be 32.

	 func Sum256(b []byte) (out [32]byte)
		Sum256 returns the unkeyed BLAKE3 hash of b, truncated to 256 bits.

	 func Sum512(b []byte) (out [64]byte)
		Sum512 returns the unkeyed BLAKE3 hash of b, truncated to 512 bits.

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.