package metadata

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

Dependency Relation
	imports 3 packages, and imported by 18 packages


Involved Source Files

	
		Package metadata define the structure of the metadata supported by gRPC library.
		Please refer to https://github.com/grpc/grpc/blob/master/doc/PROTOCOL-HTTP2.md
		for more information about custom-metadata.


Package-Level Type Names (total 4, in which 1 are exported)


	/* sort exporteds by:  |  */
	
		MD is a mapping from metadata keys to values. Users should use the following
		two convenience functions New and Pairs to generate MD.

		
			
				Append adds the values to key k, not overwriting what was already stored at that key.

			
				Copy returns a copy of md.

			
				Get obtains the values for a given key.

			
				Len returns the number of items in md.

			
				Set sets the value of a given key with a slice of values.

		
			
		
			func FromIncomingContext(ctx context.Context) (md MD, ok bool)
			func FromOutgoingContext(ctx context.Context) (MD, bool)
			func FromOutgoingContextRaw(ctx context.Context) (MD, [][]string, bool)
			func Join(mds ...MD) MD
			func New(m map[string]string) MD
			func Pairs(kv ...string) MD
			func MD.Copy() MD
			func google.golang.org/grpc.ClientStream.Header() (MD, error)
			func google.golang.org/grpc.ClientStream.Trailer() MD
			func google.golang.org/grpc/balancer/grpclb/grpc_lb_v1.LoadBalancer_BalanceLoadClient.Header() (MD, error)
			func google.golang.org/grpc/balancer/grpclb/grpc_lb_v1.LoadBalancer_BalanceLoadClient.Trailer() MD
			func google.golang.org/grpc/credentials/alts/internal/proto/grpc_gcp.HandshakerService_DoHandshakeClient.Header() (MD, error)
			func google.golang.org/grpc/credentials/alts/internal/proto/grpc_gcp.HandshakerService_DoHandshakeClient.Trailer() MD
			func google.golang.org/grpc/internal/grpcutil.ExtraMetadata(ctx context.Context) (md MD, ok bool)
			func google.golang.org/grpc/internal/transport.(*Stream).Header() (MD, error)
			func google.golang.org/grpc/internal/transport.(*Stream).Trailer() MD
		
			func Join(mds ...MD) MD
			func NewIncomingContext(ctx context.Context, md MD) context.Context
			func NewOutgoingContext(ctx context.Context, md MD) context.Context
			func google.golang.org/grpc.Header(md *MD) grpc.CallOption
			func google.golang.org/grpc.SendHeader(ctx context.Context, md MD) error
			func google.golang.org/grpc.SetHeader(ctx context.Context, md MD) error
			func google.golang.org/grpc.SetTrailer(ctx context.Context, md MD) error
			func google.golang.org/grpc.Trailer(md *MD) grpc.CallOption
			func google.golang.org/grpc.ServerStream.SendHeader(MD) error
			func google.golang.org/grpc.ServerStream.SetHeader(MD) error
			func google.golang.org/grpc.ServerStream.SetTrailer(MD)
			func google.golang.org/grpc.ServerTransportStream.SendHeader(md MD) error
			func google.golang.org/grpc.ServerTransportStream.SetHeader(md MD) error
			func google.golang.org/grpc.ServerTransportStream.SetTrailer(md MD) error
			func google.golang.org/grpc/balancer/grpclb/grpc_lb_v1.LoadBalancer_BalanceLoadServer.SendHeader(MD) error
			func google.golang.org/grpc/balancer/grpclb/grpc_lb_v1.LoadBalancer_BalanceLoadServer.SetHeader(MD) error
			func google.golang.org/grpc/balancer/grpclb/grpc_lb_v1.LoadBalancer_BalanceLoadServer.SetTrailer(MD)
			func google.golang.org/grpc/credentials/alts/internal/proto/grpc_gcp.HandshakerService_DoHandshakeServer.SendHeader(MD) error
			func google.golang.org/grpc/credentials/alts/internal/proto/grpc_gcp.HandshakerService_DoHandshakeServer.SetHeader(MD) error
			func google.golang.org/grpc/credentials/alts/internal/proto/grpc_gcp.HandshakerService_DoHandshakeServer.SetTrailer(MD)
			func google.golang.org/grpc/internal/balancerload.Parse(md MD) interface{}
			func google.golang.org/grpc/internal/balancerload.Parser.Parse(md MD) interface{}
			func google.golang.org/grpc/internal/grpcutil.WithExtraMetadata(ctx context.Context, md MD) context.Context
			func google.golang.org/grpc/internal/transport.ServerTransport.WriteHeader(s *transport.Stream, md MD) error
			func google.golang.org/grpc/internal/transport.(*Stream).SendHeader(md MD) error
			func google.golang.org/grpc/internal/transport.(*Stream).SetHeader(md MD) error
			func google.golang.org/grpc/internal/transport.(*Stream).SetTrailer(md MD) error
			


	


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


	
		AppendToOutgoingContext returns a new context with the provided kv merged
		with any existing metadata in the context. Please refer to the
		documentation of Pairs for a description of kv.


	
		DecodeKeyValue returns k, v, nil.

		Deprecated: use k and v directly instead.


	
		FromIncomingContext returns the incoming metadata in ctx if it exists.  The
		returned MD should not be modified. Writing to it may cause races.
		Modification should be made to copies of the returned MD.


	
		FromOutgoingContext returns the outgoing metadata in ctx if it exists.  The
		returned MD should not be modified. Writing to it may cause races.
		Modification should be made to copies of the returned MD.


	
		FromOutgoingContextRaw returns the un-merged, intermediary contents
		of rawMD. Remember to perform strings.ToLower on the keys. The returned
		MD should not be modified. Writing to it may cause races. Modification
		should be made to copies of the returned MD.

		This is intended for gRPC-internal use ONLY.


	
		Join joins any number of mds into a single MD.
		The order of values for each key is determined by the order in which
		the mds containing those values are presented to Join.


	
		New creates an MD from a given key-value map.

		Only the following ASCII characters are allowed in keys:
		 - digits: 0-9
		 - uppercase letters: A-Z (normalized to lower)
		 - lowercase letters: a-z
		 - special characters: -_.
		Uppercase letters are automatically converted to lowercase.

		Keys beginning with "grpc-" are reserved for grpc-internal use only and may
		result in errors if set in metadata.


	
		NewIncomingContext creates a new context with incoming md attached.


	
		NewOutgoingContext creates a new context with outgoing md attached. If used
		in conjunction with AppendToOutgoingContext, NewOutgoingContext will
		overwrite any previously-appended metadata.


	
		Pairs returns an MD formed by the mapping of key, value ...
		Pairs panics if len(kv) is odd.

		Only the following ASCII characters are allowed in keys:
		 - digits: 0-9
		 - uppercase letters: A-Z (normalized to lower)
		 - lowercase letters: a-z
		 - special characters: -_.
		Uppercase letters are automatically converted to lowercase.

		Keys beginning with "grpc-" are reserved for grpc-internal use only and may
		result in errors if set in metadata.