Package: github.com/multiformats/go-multihash

package multihash Import Path github.com/multiformats/go-multihash (on go.dev) Dependency Relation imports 11 packages, and imported by 5 packages

Involved Source Files io.go d multihash.go Package multihash is the Go implementation of https://github.com/multiformats/multihash, or self-describing hashes. registry.go set.go sum.go

Package-Level Type Names (total 6)

/* sort by: alphabet | popularity */

type DecodedMultihash (struct) DecodedMultihash represents a parsed multihash and allows easy access to the different parts of a multihash. Fields (total 4) Code uint64 Digest []byte // Digest holds the raw multihash bytes Length int // Length is just int as it is type of len() opearator Name string As Outputs Of (at least one exported) func Decode(buf []byte) (*DecodedMultihash, error)

type ErrInconsistentLen (struct) ErrInconsistentLen is returned when a decoded multihash has an inconsistent length Methods (only one) ( ErrInconsistentLen) Error() string Implements (at least one exported) ErrInconsistentLen : error

type Multihash ([]) Multihash is byte slice with the following form: <hash function code><digest size><hash function output>. See the spec for more information. Methods (total 3) ( Multihash) B58String() string B58String returns the B58-encoded representation of a multihash. ( Multihash) HexString() string HexString returns the hex-encoded representation of a multihash. ( Multihash) String() string String is an alias to HexString(). Implements (at least 2) Multihash : expvar.Var Multihash : fmt.Stringer As Outputs Of (at least 9) func Cast(buf []byte) (Multihash, error) func FromB58String(s string) (m Multihash, err error) func FromHexString(s string) (Multihash, error) func MHFromBytes(buf []byte) (int, Multihash, error) func Sum(data []byte, code uint64, length int) (Multihash, error) func SumStream(r io.Reader, code uint64, length int) (Multihash, error) func Reader.ReadMultihash() (Multihash, error) func (*Set).All() []Multihash func github.com/ipfs/go-cid.Cid.Hash() Multihash As Inputs Of (at least 7) func (*Set).Add(m Multihash) func (*Set).Has(m Multihash) bool func (*Set).Remove(m Multihash) func (*Set).Visit(m Multihash) bool func Writer.WriteMultihash(Multihash) error func github.com/ipfs/go-cid.NewCidV0(mhash Multihash) cid.Cid func github.com/ipfs/go-cid.NewCidV1(codecType uint64, mhash Multihash) cid.Cid

type Reader (interface) Reader is an io.Reader wrapper that exposes a function to read a whole multihash, parse it, and return it. Methods (total 2) ( Reader) Read(p []byte) (n int, err error) ( Reader) ReadMultihash() (Multihash, error) Implements (at least one exported) Reader : io.Reader As Outputs Of (at least one exported) func NewReader(r io.Reader) Reader

type Set (struct) Set is a set of Multihashes, holding one copy per Multihash. Methods (total 7) (*Set) Add(m Multihash) Add adds a new multihash to the set. (*Set) All() []Multihash All returns a slice with all the elements in the set. (*Set) ForEach(f func(m Multihash) error) error ForEach runs f(m) with each multihash in the set. If returns immediately if f(m) returns an error. (*Set) Has(m Multihash) bool Has returns true if the element is in the set. (*Set) Len() int Len returns the number of elements in the set. (*Set) Remove(m Multihash) Remove removes an element from the set. (*Set) Visit(m Multihash) bool Visit adds a multihash only if it is not in the set already. Returns true if the multihash was added (was not in the set before). As Outputs Of (at least one exported) func NewSet() *Set

type Writer (interface) Writer is an io.Writer wrapper that exposes a function to write a whole multihash. Methods (total 2) ( Writer) Write([]byte) (int, error) ( Writer) WriteMultihash(Multihash) error Implements (at least 3) Writer : github.com/miekg/dns.Writer Writer : internal/bisect.Writer Writer : io.Writer As Outputs Of (at least one exported) func NewWriter(w io.Writer) Writer

Package-Level Functions (total 14)

func Cast(buf []byte) (Multihash, error) Cast casts a buffer onto a multihash, and returns an error if it does not work.

func Decode(buf []byte) (*DecodedMultihash, error) Decode parses multihash bytes into a DecodedMultihash.

func Encode(buf []byte, code uint64) ([]byte, error) Encode a hash digest along with the specified function code. Note: the length is derived from the length of the digest itself. The error return is legacy; it is always nil.

func EncodeName(buf []byte, name string) ([]byte, error) EncodeName is like Encode() but providing a string name instead of a numeric code. See Names for allowed values.

func FromB58String(s string) (m Multihash, err error) FromB58String parses a B58-encoded multihash.

func FromHexString(s string) (Multihash, error) FromHexString parses a hex-encoded multihash.

func GetHasher(indicator uint64) (hash.Hash, error) Register is an alias for Register in the core package. Consider using the core package instead of this multihash package; that package does not introduce transitive dependencies except for those you opt into, and will can result in smaller application builds.

func MHFromBytes(buf []byte) (int, Multihash, error) MHFromBytes reads a multihash from the given byte buffer, returning the number of bytes read as well as the multihash

func NewReader(r io.Reader) Reader NewReader wraps an io.Reader with a multihash.Reader

func NewSet() *Set NewSet creates a new set correctly initialized.

func NewWriter(w io.Writer) Writer NewWriter wraps an io.Writer with a multihash.Writer

func Register(indicator uint64, hasherFactory func() hash.Hash) Register is an alias for Register in the core package. Consider using the core package instead of this multihash package; that package does not introduce transitive dependencies except for those you opt into, and will can result in smaller application builds.

func Sum(data []byte, code uint64, length int) (Multihash, error) Sum obtains the cryptographic sum of a given buffer. The length parameter indicates the length of the resulting digest. Passing a negative value uses default length values for the selected hash function.

func SumStream(r io.Reader, code uint64, length int) (Multihash, error) SumStream obtains the cryptographic sum of a given stream. The length parameter indicates the length of the resulting digest. Passing a negative value uses default length values for the selected hash function.

Package-Level Variables (total 12)

var Codes map[uint64]string Codes maps a hash code to it's name

var DefaultLengths map[uint64]int DefaultLengths maps a multihash indicator code to the output size for that hash, in units of bytes.

var ErrInvalidMultihash error errors

var ErrLenNotSupported error errors

var ErrLenTooLarge error

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

var ErrTooLong error errors

var ErrTooShort error errors

var ErrUnknownCode error errors

var ErrVarintBufferShort error errors

var ErrVarintTooLong error errors

var Names map[string]uint64 Names maps the name of a hash to the code

Package-Level Constants (total 28)

const BLAKE2B_MAX = 45632 constants

const BLAKE2B_MIN = 45569 constants

const BLAKE2S_MAX = 45664 constants

const BLAKE2S_MIN = 45633 constants

const BLAKE3 = 30 constants

const DBL_SHA2_256 = 86 constants

const ID = 0 Deprecated: use IDENTITY

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 MURMUR3 = 34 Deprecated: use MURMUR3X64_64

const MURMUR3X64_64 = 34 constants

const POSEIDON_BLS12_381_A1_FC1 = 46081 constants

const SHA1 = 17 constants

const SHA2_256 = 18 constants

const SHA2_256_TRUNC254_PADDED = 4114 constants

const SHA2_512 = 19 constants

const SHA3 = 20 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

const X11 = 4352 constants