metadata

Documentation

Index

• func AppendToClientContext(ctx context.Context, kv ...string) context.Context
• func Client(opts ...Option) endpoint.Middleware
• func MergeToClientContext(ctx context.Context, cmd Metadata) context.Context
• func NewClientContext(ctx context.Context, md Metadata) context.Context
• func NewServerContext(ctx context.Context, md Metadata) context.Context
• func Server(opts ...Option) endpoint.Middleware
• type Metadata
  • func FromClientContext(ctx context.Context) (Metadata, bool)
  • func FromServerContext(ctx context.Context) (Metadata, bool)
  • func New(mds ...map[string]string) Metadata
  • func (m Metadata) Clone() Metadata
  • func (m Metadata) Get(key string) string
  • func (m Metadata) Range(f func(k, v string) bool)
  • func (m Metadata) Set(key string, value string)
• type Option
  • func WithConstants(md Metadata) Option
  • func WithPropagatedPrefix(prefix ...string) Option

Functions

func AppendToClientContext

func AppendToClientContext(ctx context.Context, kv ...string) context.Context

AppendToClientContext returns a new context with the provided kv merged with any existing metadata in the context.

func Client

func Client(opts ...Option) endpoint.Middleware

Client is middleware client-side metadata.

func MergeToClientContext

func MergeToClientContext(ctx context.Context, cmd Metadata) context.Context

MergeToClientContext merge new metadata into ctx.

func NewClientContext

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

NewClientContext creates a new context with client md attached.

func NewServerContext

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

NewServerContext creates a new context with client md attached.

func Server

func Server(opts ...Option) endpoint.Middleware

Server is middleware server-side 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 FromClientContext

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

FromClientContext returns the client metadata in ctx if it exists.

func FromServerContext

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

FromServerContext returns the server metadata in ctx if it exists.

func New

func New(mds ...map[string]string) Metadata

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

func (Metadata) Clone

func (m Metadata) Clone() Metadata

Clone returns a deep copy of Metadata

func (Metadata) Get

func (m Metadata) Get(key string) string

Get returns the value associated with the passed key.

func (Metadata) Range

func (m Metadata) Range(f func(k, v string) bool)

Range iterate over element in metadata.

func (Metadata) Set

func (m Metadata) Set(key string, value string)

Set stores the key-value pair.

type Option

type Option func(*options)

Option is metadata option.

func WithConstants

func WithConstants(md Metadata) Option

WithConstants with constant metadata key value.

func WithPropagatedPrefix

func WithPropagatedPrefix(prefix ...string) Option

WithPropagatedPrefix with propagated key prefix.