metadata

Documentation

Overview

Package metadata allows for the definition of metadata such as headers

Index

• func Get(ctx context.Context, key string) (string, bool)
• func MergeContext(ctx context.Context, patchMd MD, overwrite bool) context.Context
• func NewContext(ctx context.Context, md MD) context.Context
• type MD
  • func Copy(md MD) MD
  • func FromContext(ctx context.Context) (MD, bool)
  • func (md MD) Append(append MD)
• type Manager
  • func NewManager(ctx *broker.Context, resource string, params specs.Header) *Manager
  • func (manager *Manager) Marshal(store references.Store) MD
  • func (manager *Manager) Unmarshal(metadata MD, store references.Store)

Functions

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 MD, overwrite bool) context.Context

MergeContext merges metadata to existing metadata, overwriting if specified

func NewContext

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

NewContext creates a new context with the given metadata

Types

type MD

type MD map[string]string

MD 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 MD) MD

Copy makes a copy of the metadata

func FromContext

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

FromContext returns metadata from the given context

func (MD) Append

func (md MD) Append(append MD)

Append appends the given md

type Manager

type Manager struct {
	Context  *broker.Context
	Resource string
	Params   specs.Header
	Keys     map[string]struct{}
}

Manager represents a metadata manager for a given resource

func NewManager

func NewManager(ctx *broker.Context, resource string, params specs.Header) *Manager

NewManager constructs a new metadata manager for the given resource.

func (*Manager) Marshal

func (manager *Manager) Marshal(store references.Store) MD

Marshal attempts to marshal the given metadata specs from the given refs store

func (*Manager) Unmarshal

func (manager *Manager) Unmarshal(metadata MD, store references.Store)

Unmarshal unmarshals the given transport metadata into the given reference store