package multihash

Import Path
	github.com/multiformats/go-multihash/core (on go.dev)

Dependency Relation
	imports 8 packages, and imported by 6 packages

Involved Source Files

	    errata.go
	    magic.go
	    registry.go
Package-Level Functions (total 4)

	 func GetHasher(indicator uint64) (hash.Hash, error)
		GetHasher returns a new hash.Hash according to the indicator code number provided.
		
		The indicator code should be per the numbers reserved and described in
		https://github.com/multiformats/multicodec/blob/master/table.csv .
		
		The actual hashers available are determined by what has been registered.
		The registry automatically contains those hashers which are available in the golang standard libraries
		(which includes md5, sha1, sha256, sha384, sha512, and the "identity" mulithash, among others).
		Other hash implementations can be made available by using the Register function.
		The 'go-mulithash/register/*' packages can also be imported to gain more common hash functions.
		
		If an error is returned, it will match `errors.Is(err, ErrSumNotSupported)`.

	 func GetVariableHasher(indicator uint64, sizeHint int) (hash.Hash, error)
		GetVariableHasher returns a new hash.Hash according to the indicator code number provided, with
		the specified size hint.
		
		NOTE: The size hint is only a hint. Hashers will attempt to produce at least the number of requested bytes, but may not.
		
		This function can fail if either the hash code is not registered, or the passed size hint is
		statically incompatible with the specified hash function.

	 func Register(indicator uint64, hasherFactory func() hash.Hash)
		Register adds a new hash to the set available from GetHasher and Sum.
		
		Register has a global effect and should only be used at package init time to avoid data races.
		
		The indicator code should be per the numbers reserved and described in
		https://github.com/multiformats/multicodec/blob/master/table.csv .
		
		If Register is called with the same indicator code more than once, the last call wins.
		In practice, this means that if an application has a strong opinion about what implementation to use for a certain hash
		(e.g., perhaps they want to override the sha256 implementation to use a special hand-rolled assembly variant
		rather than the stdlib one which is registered by default),
		then this can be done by making a Register call with that effect at init time in the application's main package.
		This should have the desired effect because the root of the import tree has its init time effect last.

	 func RegisterVariableSize(indicator uint64, hasherFactory func(sizeHint int) (hash.Hash, bool))
		RegisterVariableSize is like Register, but adds a new variable-sized hasher factory that takes a
		size hint.
		
		When passed -1, the hasher should produce digests with the hash-function's default length. When
		passed a non-negative integer, the hasher should try to produce digests of at least the specified
		size.


Package-Level Variables (total 3)

	  var DefaultLengths map[uint64]int
		DefaultLengths maps a multihash indicator code to the output size for that hash, in units of bytes.
		
		This map is populated when a hash function is registered by the Register function.
		It's effectively a shortcut for asking Size() on the hash.Hash.

	  var ErrLenTooLarge error
		ErrLenTooLarge is returned when the hash function cannot produce the requested number of bytes

	  var ErrSumNotSupported error
		ErrSumNotSupported is returned when the Sum function code is not implemented


Package-Level Constants (total 22)

	const BLAKE3 = 30
		constants

	const DBL_SHA2_256 = 86
		constants

	const IDENTITY = 0
		constants

	const KECCAK_224 = 26
		constants

	const KECCAK_256 = 27
		constants

	const KECCAK_384 = 28
		constants

	const KECCAK_512 = 29
		constants

	const MD5 = 213
		constants

	const MURMUR3X64_64 = 34
		constants

	const SHA1 = 17
		constants

	const SHA2_224 = 4115
		constants

	const SHA2_256 = 18
		constants

	const SHA2_384 = 32
		constants

	const SHA2_512 = 19
		constants

	const SHA2_512_224 = 4116
		constants

	const SHA2_512_256 = 4117
		constants

	const SHA3_224 = 23
		constants

	const SHA3_256 = 22
		constants

	const SHA3_384 = 21
		constants

	const SHA3_512 = 20
		constants

	const SHAKE_128 = 24
		constants

	const SHAKE_256 = 25
		constants

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.