types

Documentation

Index

• Constants
• Variables
• func EncodeResponse(_ context.Context, w http.ResponseWriter, response interface{}) error
• type ErrorRes
• type Identifier
  • func NewIdentifier(v string) (Identifier, error)
  • func (i *Identifier) IsValid() bool
  • func (i *Identifier) Scan(value interface{}) error
  • func (i *Identifier) String() string
  • func (i Identifier) Value() (driver.Value, error)
• type Metadata
  • func FromMap(m map[string]interface{}) Metadata
  • func (s *Metadata) FilterMap(predicateFunc func(string) bool, ...)
  • func (s *Metadata) GetSubMetadata(key string) Metadata
  • func (s *Metadata) IsApplicable(filterFunc func(string, interface{}) bool) bool
  • func (s *Metadata) Merge(metadataToAdd Metadata)
  • func (s *Metadata) RemoveKeys(keys []string)
  • func (s *Metadata) RestrictKeys(predicate func(string) bool)
  • func (s *Metadata) Scan(src interface{}) error
• type Response
• type Tags
  • func (t *Tags) Merge(newTags map[string]string)

Constants

const (
	ContentType = "application/json"
)

Variables

var (

	// ErrBadIdentifier indicates a bad identifer pattern
	ErrBadIdentifier = errors.New("invalid identifier, must match " + idRegexp)
)

Functions

func EncodeResponse

func EncodeResponse(_ context.Context, w http.ResponseWriter, response interface{}) error

Types

type ErrorRes

type ErrorRes struct {
	Err string `json:"error"`
}

type Identifier

type Identifier struct {
	// contains filtered or unexported fields
}

func NewIdentifier

func NewIdentifier(v string) (Identifier, error)

func (*Identifier) IsValid

func (i *Identifier) IsValid() bool

func (*Identifier) Scan

func (i *Identifier) Scan(value interface{}) error

Scan - Implement the database/sql scanner interface

func (*Identifier) String

func (i *Identifier) String() string

func (Identifier) Value

func (i Identifier) Value() (driver.Value, error)

Value Implements valuer

type Metadata

type Metadata map[string]interface{}

Metadata Maybe a full object hierarchy

func FromMap

func FromMap(m map[string]interface{}) Metadata

func (*Metadata) FilterMap

func (s *Metadata) FilterMap(predicateFunc func(string) bool, mapFunc func(string, interface{}) (string, interface{}))

func (*Metadata) GetSubMetadata

func (s *Metadata) GetSubMetadata(key string) Metadata

GetSubMetadata gets the first substructure with the keyname or nil

func (*Metadata) IsApplicable

func (s *Metadata) IsApplicable(filterFunc func(string, interface{}) bool) bool

func (*Metadata) Merge

func (s *Metadata) Merge(metadataToAdd Metadata)

func (*Metadata) RemoveKeys

func (s *Metadata) RemoveKeys(keys []string)

func (*Metadata) RestrictKeys

func (s *Metadata) RestrictKeys(predicate func(string) bool)

func (*Metadata) Scan

func (s *Metadata) Scan(src interface{}) error

type Response

type Response interface {
	// Code returns HTTP response code.
	Code() int

	// Headers returns map of HTTP headers with their values.
	Headers() map[string]string

	// Empty indicates if HTTP response has content.
	Empty() bool
}

Response contains HTTP response specific methods.

type Tags

type Tags map[string]string

Tags A flat kv pair object

func (*Tags) Merge

func (t *Tags) Merge(newTags map[string]string)