Documentation
¶
Overview ¶
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.
Index ¶
- func AppendToOutgoingContext(ctx context.Context, kv ...string) context.Context
- func DecodeKeyValue(k, v string) (string, string, error)deprecated
- func NewIncomingContext(ctx context.Context, md MD) context.Context
- func NewOutgoingContext(ctx context.Context, md MD) context.Context
- func ValueFromIncomingContext(ctx context.Context, key string) []string
- type MD
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func AppendToOutgoingContext ¶ added in v1.10.0
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.
func DecodeKeyValue
deprecated
func NewIncomingContext ¶ added in v1.3.0
NewIncomingContext creates a new context with incoming md attached. md must not be modified after calling this function.
func NewOutgoingContext ¶ added in v1.3.0
NewOutgoingContext creates a new context with outgoing md attached. If used in conjunction with AppendToOutgoingContext, NewOutgoingContext will overwrite any previously-appended metadata. md must not be modified after calling this function.
func ValueFromIncomingContext ¶ added in v1.50.0
ValueFromIncomingContext returns the metadata value corresponding to the metadata key from the incoming metadata if it exists. Keys are matched in a case insensitive manner.
Experimental ¶
Notice: This API is EXPERIMENTAL and may be changed or removed in a later release.
Types ¶
type MD ¶
MD is a mapping from metadata keys to values. Users should use the following two convenience functions New and Pairs to generate MD.
func FromIncomingContext ¶ added in v1.3.0
FromIncomingContext returns the incoming metadata in ctx if it exists.
All keys in the returned MD are lowercase.
func FromOutgoingContext ¶ added in v1.3.0
FromOutgoingContext returns the outgoing metadata in ctx if it exists.
All keys in the returned MD are lowercase.
func Join ¶ added in v1.0.2
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.
func New ¶
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.
func Pairs ¶
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.
func (MD) Append ¶ added in v1.12.0
Append adds the values to key k, not overwriting what was already stored at that key.
k is converted to lowercase before storing in md.
func (MD) Delete ¶ added in v1.40.0
Delete removes the values for a given key k which is converted to lowercase before removing it from md.
Source Files