Package: google.golang.org/grpc/metadata

package metadata Import Path google.golang.org/grpc/metadata (on go.dev) Dependency Relation imports 4 packages, and imported by 13 packages Involved Source Files d metadata.go 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 (only one) /* sort by: alphabet | popularity */ type MD (map) MD is a mapping from metadata keys to values. Users should use the following two convenience functions New and Pairs to generate MD. Methods (total 6) ( MD) Append(k string, vals ...string) 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. ( MD) Copy() MD Copy returns a copy of md. ( MD) Delete(k string) Delete removes the values for a given key k which is converted to lowercase before removing it from md. ( MD) Get(k string) []string Get obtains the values for a given key. k is converted to lowercase before searching in md. ( MD) Len() int Len returns the number of items in md. ( MD) Set(k string, vals ...string) Set sets the value of a given key with a slice of values. k is converted to lowercase before storing in md. As Outputs Of (at least 29) func FromIncomingContext(ctx context.Context) (MD, bool) func FromOutgoingContext(ctx context.Context) (MD, 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.BidiStreamingClient.Header() (MD, error) func google.golang.org/grpc.BidiStreamingClient.Trailer() MD func google.golang.org/grpc.ClientStream.Header() (MD, error) func google.golang.org/grpc.ClientStream.Trailer() MD func google.golang.org/grpc.ClientStreamingClient.Header() (MD, error) func google.golang.org/grpc.ClientStreamingClient.Trailer() MD func google.golang.org/grpc.ServerStreamingClient.Header() (MD, error) func google.golang.org/grpc.ServerStreamingClient.Trailer() MD func google.golang.org/grpc/health/grpc_health_v1.Health_WatchClient.Header() (MD, error) func google.golang.org/grpc/health/grpc_health_v1.Health_WatchClient.Trailer() MD func google.golang.org/grpc/internal/grpcutil.ExtraMetadata(ctx context.Context) (md MD, ok bool) func google.golang.org/grpc/internal/metadata.Get(addr resolver.Address) MD func google.golang.org/grpc/internal/resolver.ClientStream.Header() (MD, error) func google.golang.org/grpc/internal/resolver.ClientStream.Trailer() MD func google.golang.org/grpc/internal/transport.(*ClientStream).Header() (MD, error) func google.golang.org/grpc/internal/transport.(*ServerStream).Header() (MD, error) func google.golang.org/grpc/internal/transport.(*Stream).Trailer() MD func github.com/grpc-ecosystem/grpc-gateway/v2/runtime.(*ServerTransportStream).Header() MD func github.com/grpc-ecosystem/grpc-gateway/v2/runtime.(*ServerTransportStream).Trailer() MD func github.com/pancsta/asyncmachine-go/examples/benchmark_grpc/proto.WorkerService_SubscribeClient.Header() (MD, error) func github.com/pancsta/asyncmachine-go/examples/benchmark_grpc/proto.WorkerService_SubscribeClient.Trailer() MD func github.com/pancsta/asyncmachine-go/examples/benchmark_grpc/worker_proto.WorkerService_SubscribeClient.Header() (MD, error) func github.com/pancsta/asyncmachine-go/examples/benchmark_grpc/worker_proto.WorkerService_SubscribeClient.Trailer() MD As Inputs Of (at least 43) 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.BidiStreamingServer.SendHeader(MD) error func google.golang.org/grpc.BidiStreamingServer.SetHeader(MD) error func google.golang.org/grpc.BidiStreamingServer.SetTrailer(MD) func google.golang.org/grpc.ClientStreamingServer.SendHeader(MD) error func google.golang.org/grpc.ClientStreamingServer.SetHeader(MD) error func google.golang.org/grpc.ClientStreamingServer.SetTrailer(MD) 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.ServerStreamingServer.SendHeader(MD) error func google.golang.org/grpc.ServerStreamingServer.SetHeader(MD) error func google.golang.org/grpc.ServerStreamingServer.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/health/grpc_health_v1.Health_WatchServer.SendHeader(MD) error func google.golang.org/grpc/health/grpc_health_v1.Health_WatchServer.SetHeader(MD) error func google.golang.org/grpc/health/grpc_health_v1.Health_WatchServer.SetTrailer(MD) func google.golang.org/grpc/internal/balancerload.Parse(md MD) any func google.golang.org/grpc/internal/balancerload.Parser.Parse(md MD) any func google.golang.org/grpc/internal/grpcutil.WithExtraMetadata(ctx context.Context, md MD) context.Context func google.golang.org/grpc/internal/metadata.Set(addr resolver.Address, md MD) resolver.Address func google.golang.org/grpc/internal/metadata.Validate(md MD) error func google.golang.org/grpc/internal/transport.(*ServerStream).SendHeader(md MD) error func google.golang.org/grpc/internal/transport.(*ServerStream).SetHeader(md MD) error func google.golang.org/grpc/internal/transport.(*ServerStream).SetTrailer(md MD) error func github.com/grpc-ecosystem/grpc-gateway/v2/runtime.(*ServerTransportStream).SendHeader(md MD) error func github.com/grpc-ecosystem/grpc-gateway/v2/runtime.(*ServerTransportStream).SetHeader(md MD) error func github.com/grpc-ecosystem/grpc-gateway/v2/runtime.(*ServerTransportStream).SetTrailer(md MD) error func github.com/pancsta/asyncmachine-go/examples/benchmark_grpc/proto.WorkerService_SubscribeServer.SendHeader(MD) error func github.com/pancsta/asyncmachine-go/examples/benchmark_grpc/proto.WorkerService_SubscribeServer.SetHeader(MD) error func github.com/pancsta/asyncmachine-go/examples/benchmark_grpc/proto.WorkerService_SubscribeServer.SetTrailer(MD) func github.com/pancsta/asyncmachine-go/examples/benchmark_grpc/worker_proto.WorkerService_SubscribeServer.SendHeader(MD) error func github.com/pancsta/asyncmachine-go/examples/benchmark_grpc/worker_proto.WorkerService_SubscribeServer.SetHeader(MD) error func github.com/pancsta/asyncmachine-go/examples/benchmark_grpc/worker_proto.WorkerService_SubscribeServer.SetTrailer(MD) Package-Level Functions (total 10) func AppendToOutgoingContext(ctx context.Context, kv ...string) context.Context 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(k, v string) (string, string, error) DecodeKeyValue returns k, v, nil. Deprecated: use k and v directly instead. func FromIncomingContext(ctx context.Context) (MD, bool) FromIncomingContext returns the incoming metadata in ctx if it exists. All keys in the returned MD are lowercase. func FromOutgoingContext(ctx context.Context) (MD, bool) FromOutgoingContext returns the outgoing metadata in ctx if it exists. All keys in the returned MD are lowercase. func Join(mds ...MD) MD 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(m map[string]string) MD 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 NewIncomingContext(ctx context.Context, md MD) context.Context NewIncomingContext creates a new context with incoming md attached. md must not be modified after calling this function. func NewOutgoingContext(ctx context.Context, md MD) context.Context 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 Pairs(kv ...string) MD 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 ValueFromIncomingContext(ctx context.Context, key string) []string 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.

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.