package qpack

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

Dependency Relation
	imports 6 packages, and imported by one package

Involved Source Files

	    decoder.go
	    encoder.go
	    header_field.go
	    static_table.go
	    varint.go
Package-Level Type Names (total 3)

	/* sort by: alphabet | popularity */
	 type Decoder (struct)
		A Decoder is the decoding context for incremental processing of
		header blocks.

		Methods (total 3)
			(*Decoder) Close() error
				Close declares that the decoding is complete and resets the Decoder
				to be reused again for a new header block. If there is any remaining
				data in the decoder's buffer, Close returns an error.

			(*Decoder) DecodeFull(p []byte) ([]HeaderField, error)
				DecodeFull decodes an entire block.

			(*Decoder) Write(p []byte) (int, error)
		Implements (at least 6)
			*Decoder : github.com/miekg/dns.Writer
			*Decoder : github.com/prometheus/common/expfmt.Closer
			*Decoder : internal/bisect.Writer
			*Decoder : io.Closer
			*Decoder : io.WriteCloser
			*Decoder : io.Writer
		As Outputs Of (at least one exported)
			func NewDecoder(emitFunc func(f HeaderField)) *Decoder

	 type Encoder (struct)
		An Encoder performs QPACK encoding.

		Methods (total 2)
			(*Encoder) Close() error
				Close declares that the encoding is complete and resets the Encoder
				to be reused again for a new header block.

			(*Encoder) WriteField(f HeaderField) error
				WriteField encodes f into a single Write to e's underlying Writer.
				This function may also produce bytes for the Header Block Prefix
				if necessary. If produced, it is done before encoding f.

		Implements (at least 2)
			*Encoder : github.com/prometheus/common/expfmt.Closer
			*Encoder : io.Closer
		As Outputs Of (at least one exported)
			func NewEncoder(w io.Writer) *Encoder

	 type HeaderField (struct)
		A HeaderField is a name-value pair. Both the name and value are
		treated as opaque sequences of octets.

		Fields (total 2)
			Name string
			Value string
		Methods (only one)
			( HeaderField) IsPseudo() bool
				IsPseudo reports whether the header field is an HTTP3 pseudo header.
				That is, it reports whether it starts with a colon.
				It is not otherwise guaranteed to be a valid pseudo header field,
				though.

		As Outputs Of (at least one exported)
			func (*Decoder).DecodeFull(p []byte) ([]HeaderField, error)
		As Inputs Of (at least one exported)
			func (*Encoder).WriteField(f HeaderField) error


Package-Level Functions (total 2)

	 func NewDecoder(emitFunc func(f HeaderField)) *Decoder
		NewDecoder returns a new decoder
		The emitFunc will be called for each valid field parsed,
		in the same goroutine as calls to Write, before Write returns.

	 func NewEncoder(w io.Writer) *Encoder
		NewEncoder returns a new Encoder which performs QPACK encoding. An
		encoded data is written to w.

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.