package encoding

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

Dependency Relation
	imports 4 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.
		
		# Experimental
		
		Notice: This package is EXPERIMENTAL and may be changed or removed in a
		later release.

	    encoding_v2.go
Package-Level Type Names (total 3, all 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)
			( Codec) Marshal(v any) ([]byte, error)
				Marshal returns the wire format of v.

			( Codec) 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.

			( Codec) Unmarshal(data []byte, v any) error
				Unmarshal parses the wire format into v.

		As Outputs Of (at least one exported)
			func GetCodec(contentSubtype string) Codec
		As Inputs Of (at least 4, in which 3 are exported)
			func RegisterCodec(codec Codec)
			func google.golang.org/grpc.ForceCodec(codec Codec) grpc.CallOption
			func google.golang.org/grpc.ForceServerCodec(codec Codec) grpc.ServerOption
			/* at least one unexported ... *//* at least one unexported: */
			func google.golang.org/grpc.newCodecV1Bridge(c Codec) CodecV2

	 type CodecV2 (interface)
		CodecV2 defines the interface gRPC uses to encode and decode messages. Note
		that implementations of this interface must be thread safe; a CodecV2's
		methods can be called from concurrent goroutines.

		Methods (total 3, all are exported)
			( CodecV2) Marshal(v any) (out mem.BufferSlice, err error)
				Marshal returns the wire format of v. The buffers in the returned
				[mem.BufferSlice] must have at least one reference each, which will be freed
				by gRPC when they are no longer needed.

			( CodecV2) 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.

			( CodecV2) Unmarshal(data mem.BufferSlice, v any) error
				Unmarshal parses the wire format into v. Note that data will be freed as soon
				as this function returns. If the codec wishes to guarantee access to the data
				after this function, it must take its own reference that it frees when it is
				no longer needed.

		Implemented By (at least 2, neither is exported)
			/* 2+ unexporteds ... *//* 2+ unexporteds: */
			*google.golang.org/grpc/encoding/proto.codecV2
			 google.golang.org/grpc.codecV1Bridge
		Implements (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			 CodecV2 : google.golang.org/grpc.baseCodec
		As Outputs Of (at least 3, in which 1 is exported)
			func GetCodecV2(contentSubtype string) CodecV2
			/* 2+ unexporteds ... *//* 2+ unexporteds: */
			func google.golang.org/grpc.getCodec(name string) CodecV2
			func google.golang.org/grpc.newCodecV1Bridge(c Codec) CodecV2
		As Inputs Of (at least 3, all are exported)
			func RegisterCodecV2(codec CodecV2)
			func google.golang.org/grpc.ForceCodecV2(codec CodecV2) grpc.CallOption
			func google.golang.org/grpc.ForceServerCodecV2(codecV2 CodecV2) grpc.ServerOption

	 type Compressor (interface)
		Compressor is used for compressing and decompressing when sending or
		receiving messages.
		
		If a Compressor implements `DecompressedSize(compressedBytes []byte) int`,
		gRPC will invoke it to determine the size of the buffer allocated for the
		result of decompression.  A return value of -1 indicates unknown size.

		Methods (total 3, all are exported)
			( Compressor) 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.

			( Compressor) 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.

			( Compressor) 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 is exported)
			func RegisterCompressor(c Compressor)
			/* 7+ unexporteds ... *//* 7+ unexporteds: */
			func google.golang.org/grpc.compress(in mem.BufferSlice, cp grpc.Compressor, compressor Compressor, pool mem.BufferPool) (mem.BufferSlice, grpc.payloadFormat, error)
			func google.golang.org/grpc.decompress(compressor Compressor, d mem.BufferSlice, dc grpc.Decompressor, maxReceiveMessageSize int, pool mem.BufferPool) (mem.BufferSlice, 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 any, codec grpc.baseCodec, cp grpc.Compressor, comp Compressor, pool mem.BufferPool) (hdr []byte, data, payload mem.BufferSlice, pf grpc.payloadFormat, err error)
			func google.golang.org/grpc.recv(p *grpc.parser, c grpc.baseCodec, s grpc.recvCompressor, dc grpc.Decompressor, m any, maxReceiveMessageSize int, payInfo *grpc.payloadInfo, compressor Compressor, isServer bool) error
			func google.golang.org/grpc.recvAndDecompress(p *grpc.parser, s grpc.recvCompressor, dc grpc.Decompressor, maxReceiveMessageSize int, payInfo *grpc.payloadInfo, compressor Compressor, isServer bool) (out mem.BufferSlice, err error)
			func google.golang.org/grpc.(*Server).sendResponse(ctx context.Context, stream *transport.ServerStream, msg any, cp grpc.Compressor, opts *transport.WriteOptions, comp Compressor) error


Package-Level Functions (total 6, 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 GetCodecV2(contentSubtype string) CodecV2
		GetCodecV2 gets a registered CodecV2 by content-subtype, or nil if no CodecV2 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 Codecs are
		registered with the same name, the one registered last will take effect.

	 func RegisterCodecV2(codec CodecV2)
		RegisterCodecV2 registers the provided CodecV2 for use with all gRPC clients and
		servers.
		
		The CodecV2 will be stored and looked up by result of its Name() method, which
		should match the content-subtype of the encoding handled by the CodecV2.  This
		is case-insensitive, and is stored and looked up as lowercase.  If the
		result of calling Name() is an empty string, RegisterCodecV2 will panic. See
		Content-Type on
		https://github.com/grpc/grpc/blob/master/doc/PROTOCOL-HTTP2.md#requests for
		more details.
		
		If both a Codec and CodecV2 are registered with the same name, the CodecV2
		will be used.
		
		NOTE: this function must only be called during initialization time (i.e. in
		an init() function), and is not thread-safe.  If multiple Codecs 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]interface{}
	  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.7.6. (GOOS=linux GOARCH=amd64)