package encoding

Import Path
	google.golang.org/grpc/encoding (on go.dev)

Dependency Relation
	imports 2 packages, and imported by 2 packages

Involved Source Files

	   d➜ encoding.go
		Package encoding defines the interface for the compressor and codec, and
		functions to register and retrieve compressors and codecs.

		This package is EXPERIMENTAL.
Package-Level Type Names (total 2, both are exported)

	/* sort exporteds by: alphabet | popularity */
	 type Codec (interface)
		Codec defines the interface gRPC uses to encode and decode messages.  Note
		that implementations of this interface must be thread safe; a Codec's
		methods can be called from concurrent goroutines.

		Methods (total 3, all are exported)
			( T) Marshal(v interface{}) ([]byte, error)
				Marshal returns the wire format of v.

			( T) Name() string
				Name returns the name of the Codec implementation. The returned string
				will be used as part of content type in transmission.  The result must be
				static; the result cannot change between calls.

			( T) Unmarshal(data []byte, v interface{}) error
				Unmarshal parses the wire format into v.

		Implemented By (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			 google.golang.org/grpc/encoding/proto.codec
		Implements (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			 T : google.golang.org/grpc.baseCodec
		As Outputs Of (at least one exported)
			func GetCodec(contentSubtype string) Codec
		As Inputs Of (at least 2, both are exported)
			func RegisterCodec(codec Codec)
			func google.golang.org/grpc.ForceCodec(codec Codec) grpc.CallOption

	 type Compressor (interface)
		Compressor is used for compressing and decompressing when sending or
		receiving messages.

		Methods (total 3, all are exported)
			( T) Compress(w io.Writer) (io.WriteCloser, error)
				Compress writes the data written to wc to w after compressing it.  If an
				error occurs while initializing the compressor, that error is returned
				instead.

			( T) Decompress(r io.Reader) (io.Reader, error)
				Decompress reads data from r, decompresses it, and provides the
				uncompressed data via the returned io.Reader.  If an error occurs while
				initializing the decompressor, that error is returned instead.

			( T) Name() string
				Name is the name of the compression codec and is used to set the content
				coding header.  The result must be static; the result cannot change
				between calls.

		As Outputs Of (at least one exported)
			func GetCompressor(name string) Compressor
		As Inputs Of (at least 8, in which 1 are exported)
			func RegisterCompressor(c Compressor)
			/* 7+ unexporteds ... *//* 7+ unexporteds: */
			func google.golang.org/grpc.compress(in []byte, cp grpc.Compressor, compressor Compressor) ([]byte, error)
			func google.golang.org/grpc.decompress(compressor Compressor, d []byte, maxReceiveMessageSize int) ([]byte, int, error)
			func google.golang.org/grpc.newContextWithRPCInfo(ctx context.Context, failfast bool, codec grpc.baseCodec, cp grpc.Compressor, comp Compressor) context.Context
			func google.golang.org/grpc.prepareMsg(m interface{}, codec grpc.baseCodec, cp grpc.Compressor, comp Compressor) (hdr, payload, data []byte, err error)
			func google.golang.org/grpc.recv(p *grpc.parser, c grpc.baseCodec, s *transport.Stream, dc grpc.Decompressor, m interface{}, maxReceiveMessageSize int, payInfo *grpc.payloadInfo, compressor Compressor) error
			func google.golang.org/grpc.recvAndDecompress(p *grpc.parser, s *transport.Stream, dc grpc.Decompressor, maxReceiveMessageSize int, payInfo *grpc.payloadInfo, compressor Compressor) ([]byte, error)
			func google.golang.org/grpc.(*Server).sendResponse(t transport.ServerTransport, stream *transport.Stream, msg interface{}, cp grpc.Compressor, opts *transport.Options, comp Compressor) error


Package-Level Functions (total 4, all are exported)

	 func GetCodec(contentSubtype string) Codec
		GetCodec gets a registered Codec by content-subtype, or nil if no Codec is
		registered for the content-subtype.

		The content-subtype is expected to be lowercase.

	 func GetCompressor(name string) Compressor
		GetCompressor returns Compressor for the given compressor name.

	 func RegisterCodec(codec Codec)
		RegisterCodec registers the provided Codec for use with all gRPC clients and
		servers.

		The Codec will be stored and looked up by result of its Name() method, which
		should match the content-subtype of the encoding handled by the Codec.  This
		is case-insensitive, and is stored and looked up as lowercase.  If the
		result of calling Name() is an empty string, RegisterCodec will panic. See
		Content-Type on
		https://github.com/grpc/grpc/blob/master/doc/PROTOCOL-HTTP2.md#requests for
		more details.

		NOTE: this function must only be called during initialization time (i.e. in
		an init() function), and is not thread-safe.  If multiple Compressors are
		registered with the same name, the one registered last will take effect.

	 func RegisterCompressor(c Compressor)
		RegisterCompressor registers the compressor with gRPC by its name.  It can
		be activated when sending an RPC via grpc.UseCompressor().  It will be
		automatically accessed when receiving a message based on the content coding
		header.  Servers also use it to send a response with the same encoding as
		the request.

		NOTE: this function must only be called during initialization time (i.e. in
		an init() function), and is not thread-safe.  If multiple Compressors are
		registered with the same name, the one registered last will take effect.


Package-Level Variables (total 2, neither is exported)

	/* 2 unexporteds ... *//* 2 unexporteds: */
	  var registeredCodecs map[string]Codec
	  var registeredCompressor map[string]Compressor
Package-Level Constants (only one, which is exported)

	const Identity = "identity"
		Identity specifies the optional encoding for uncompressed streams.
		It is intended for grpc internal use only.

The pages are generated with Golds v0.3.2-preview. (GOOS=darwin 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 @Go100and1 (reachable from the left QR code) to get the latest news of Golds.