package varint

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

Dependency Relation
	imports 4 packages, and imported by 11 packages

Involved Source Files

	    varint.go
Package-Level Functions (total 5)

	 func FromUvarint(buf []byte) (uint64, int, error)
		FromUvarint reads an unsigned varint from the beginning of buf, returns the
		varint, and the number of bytes read.

	 func PutUvarint(buf []byte, x uint64) int
		PutUvarint is an alias for binary.PutUvarint.
		
		This is provided for convenience so users of this library can avoid built-in
		varint functions and easily audit code for uses of those functions.
		
		Make sure that x is smaller or equal to MaxValueUvarint63, otherwise this
		function will produce values that may be rejected by readers.

	 func ReadUvarint(r io.ByteReader) (uint64, error)
		ReadUvarint reads a unsigned varint from the given reader.

	 func ToUvarint(num uint64) []byte
		ToUvarint converts an unsigned integer to a varint-encoded []byte

	 func UvarintSize(num uint64) int
		UvarintSize returns the size (in bytes) of `num` encoded as a unsigned varint.
		
		This may return a size greater than MaxUvarintLen63, which would be an
		illegal value, and would be rejected by readers.


Package-Level Variables (total 3)

	  var ErrNotMinimal error
	  var ErrOverflow error
	  var ErrUnderflow error
Package-Level Constants (total 2)

	const MaxLenUvarint63 = 9
		MaxLenUvarint63 is the maximum number of bytes representing an uvarint in
		this encoding, supporting a maximum value of 2^63 (uint63), aka
		MaxValueUvarint63.

	const MaxValueUvarint63 = 9223372036854775807
		MaxValueUvarint63 is the maximum encodable uint63 value.

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.