metadata

Documentation

Overview

Package metadata is a way of defining message headers

Package metadata is a way of defining message headers

Index

• func Delete(ctx context.Context, k string) context.Context
• func Get(ctx context.Context, key string) (string, bool)
• func MergeContext(ctx context.Context, patchMd Metadata, overwrite bool) context.Context
• func NewContext(ctx context.Context, md Metadata) context.Context
• func NewIncomingContext(ctx context.Context, md Metadata) context.Context
• func NewOutgoingContext(ctx context.Context, md Metadata) context.Context
• func Set(ctx context.Context, k, v string) context.Context
• func SetIncomingContext(ctx context.Context, md Metadata) bool
• func SetOutgoingContext(ctx context.Context, md Metadata) bool
• type Metadata
  • func Copy(md Metadata) Metadata
  • func FromContext(ctx context.Context) (Metadata, bool)
  • func FromIncomingContext(ctx context.Context) (Metadata, bool)
  • func FromOutgoingContext(ctx context.Context) (Metadata, bool)
  • func (md Metadata) Delete(key string)
  • func (md Metadata) Get(key string) (string, bool)
  • func (md Metadata) Set(key, val string)

Functions

func Delete

func Delete(ctx context.Context, k string) context.Context

Delete key from metadata

func Get

func Get(ctx context.Context, key string) (string, bool)

Get returns a single value from metadata in the context

func MergeContext

func MergeContext(ctx context.Context, patchMd Metadata, overwrite bool) context.Context

MergeContext merges metadata to existing metadata, overwriting if specified

func NewContext

func NewContext(ctx context.Context, md Metadata) context.Context

NewContext creates a new context with the given metadata

Deprecated: use NewIncomingContext or NewOutgoingContext

func NewIncomingContext

func NewIncomingContext(ctx context.Context, md Metadata) context.Context

NewIncomingContext creates a new context with incoming metadata attached

func NewOutgoingContext

func NewOutgoingContext(ctx context.Context, md Metadata) context.Context

NewOutgoingContext creates a new context with outcoming metadata attached

func Set

func Set(ctx context.Context, k, v string) context.Context

Set add key with val to metadata

func SetIncomingContext

func SetIncomingContext(ctx context.Context, md Metadata) bool

SetIncomingContext modify incoming context with given metadata

func SetOutgoingContext

func SetOutgoingContext(ctx context.Context, md Metadata) bool

SetOutgoingContext modify outgoing context with given metadata

Types

type Metadata

type Metadata map[string]string

Metadata is our way of representing request headers internally. They're used at the RPC level and translate back and forth from Transport headers.

func Copy

func Copy(md Metadata) Metadata

Copy makes a copy of the metadata

func FromContext

func FromContext(ctx context.Context) (Metadata, bool)

FromContext returns metadata from the given context returned metadata shoud not be modified or race condition happens

Deprecated: use FromIncomingContext or FromOutgoingContext

func FromIncomingContext

func FromIncomingContext(ctx context.Context) (Metadata, bool)

FromIncomingContext returns metadata from incoming ctx returned metadata shoud not be modified or race condition happens

func FromOutgoingContext

func FromOutgoingContext(ctx context.Context) (Metadata, bool)

FromOutgoingContext returns metadata from outgoing ctx returned metadata shoud not be modified or race condition happens

func (Metadata) Delete

func (md Metadata) Delete(key string)

func (Metadata) Get

func (md Metadata) Get(key string) (string, bool)

func (Metadata) Set

func (md Metadata) Set(key, val string)