package quicvarint

Import Path
	github.com/quic-go/quic-go/quicvarint (on go.dev)

Dependency Relation
	imports 4 packages, and imported by 6 packages

Involved Source Files

	    io.go
	    varint.go
Package-Level Type Names (total 3)

	/* sort by: alphabet | popularity */
	 type Peeker (interface)
		A Peeker can peek bytes without consuming them.

		Methods (only one)
			( Peeker) Peek(b []byte) (int, error)
		Implemented By (at least 2)
			*github.com/quic-go/quic-go.ReceiveStream
			*github.com/quic-go/quic-go.Stream
		As Inputs Of (at least one exported)
			func Peek(p Peeker) (uint64, error)

	 type Reader (interface)
		Reader implements both the io.ByteReader and io.Reader interfaces.

		Methods (total 2)
			( Reader) Read(p []byte) (n int, err error)
			( Reader) ReadByte() (byte, error)
		Implemented By (at least 21)
			*github.com/apache/thrift/lib/go/thrift.RichTransport
			*github.com/apache/thrift/lib/go/thrift.StreamTransport
			*github.com/apache/thrift/lib/go/thrift.TBufferedTransport
			*github.com/apache/thrift/lib/go/thrift.TFramedTransport
			*github.com/apache/thrift/lib/go/thrift.THttpClient
			 github.com/apache/thrift/lib/go/thrift.TMemoryBuffer
			 github.com/apache/thrift/lib/go/thrift.TRichTransport (interface)
			*github.com/golang/snappy.Reader
			 github.com/klauspost/compress/flate.Reader (interface)
			*github.com/klauspost/compress/internal/snapref.Reader
			*github.com/klauspost/compress/s2.Reader
			 github.com/klauspost/compress/s2.ReadSeeker
			*github.com/libp2p/go-buffer-pool.Buffer
			*bufio.Reader
			 bufio.ReadWriter
			*bytes.Buffer
			*bytes.Reader
			 compress/flate.Reader (interface)
			*google.golang.org/grpc/mem.Reader
			 google.golang.org/protobuf/encoding/protodelim.Reader (interface)
			*strings.Reader
		Implements (at least 5)
			 Reader : github.com/klauspost/compress/flate.Reader
			 Reader : compress/flate.Reader
			 Reader : google.golang.org/protobuf/encoding/protodelim.Reader
			 Reader : io.ByteReader
			 Reader : io.Reader
		As Outputs Of (at least one exported)
			func NewReader(r io.Reader) Reader
		As Inputs Of (at least one exported)
			func github.com/quic-go/quic-go/http3.ParseCapsule(r Reader) (http3.CapsuleType, io.Reader, error)

	 type Writer (interface)
		Writer implements both the io.ByteWriter and io.Writer interfaces.

		Methods (total 2)
			( Writer) Write([]byte) (int, error)
			( Writer) WriteByte(c byte) error
		Implemented By (at least 20)
			*github.com/apache/thrift/lib/go/thrift.RichTransport
			*github.com/apache/thrift/lib/go/thrift.StreamTransport
			*github.com/apache/thrift/lib/go/thrift.TBufferedTransport
			*github.com/apache/thrift/lib/go/thrift.TFramedTransport
			*github.com/apache/thrift/lib/go/thrift.THttpClient
			 github.com/apache/thrift/lib/go/thrift.TMemoryBuffer
			 github.com/apache/thrift/lib/go/thrift.TRichTransport (interface)
			*github.com/libp2p/go-buffer-pool.Buffer
			*github.com/libp2p/go-buffer-pool.Writer
			 github.com/redis/go-redis/v9/internal/proto.Writer
			 github.com/yuin/goldmark/util.BufWriter (interface)
			 bufio.ReadWriter
			*bufio.Writer
			*bytes.Buffer
			*go.uber.org/zap/buffer.Buffer
			*hash/maphash.Hash
			*log/slog/internal/buffer.Buffer
			 mvdan.cc/sh/v3/syntax.Printer
			 net/http/internal.FlushAfterChunkWriter
			*strings.Builder
		Implements (at least 4)
			 Writer : github.com/miekg/dns.Writer
			 Writer : internal/bisect.Writer
			 Writer : io.ByteWriter
			 Writer : io.Writer
		As Outputs Of (at least one exported)
			func NewWriter(w io.Writer) Writer
		As Inputs Of (at least one exported)
			func github.com/quic-go/quic-go/http3.WriteCapsule(w Writer, ct http3.CapsuleType, value []byte) error


Package-Level Functions (total 8)

	 func Append(b []byte, i uint64) []byte
		Append appends i in the QUIC varint format.

	 func AppendWithLen(b []byte, i uint64, length int) []byte
		AppendWithLen append i in the QUIC varint format with the desired length.

	 func Len(i uint64) int
		Len determines the number of bytes that will be needed to write the number i.

	 func NewReader(r io.Reader) Reader
		NewReader returns a Reader for r.
		If r already implements both io.ByteReader and io.Reader, NewReader returns r.
		Otherwise, r is wrapped to add the missing interfaces.

	 func NewWriter(w io.Writer) Writer
		NewWriter returns a Writer for w.
		If w already implements both io.ByteWriter and io.Writer, NewWriter returns w.
		Otherwise, w is wrapped to add the missing interfaces.

	 func Parse(b []byte) (uint64, int, error)
		Parse reads a number in the QUIC varint format.
		It returns the number of bytes consumed.

	 func Peek(p Peeker) (uint64, error)
		Peek reads a number in the QUIC varint format without consuming bytes.

	 func Read(r io.ByteReader) (uint64, error)
		Read reads a number in the QUIC varint format from r.


Package-Level Constants (total 2)

	const Max = 4611686018427387903
		Max is the maximum allowed value for a QUIC varint (2^62-1).

	const Min = 0
		Min is the minimum value allowed for a QUIC varint.

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.