Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

goa

package module

Go to main page

Versions in this module

v1

v1.0.0

Aug 2, 2016

Changes in this version

+ const ErrMissingLogValue

+ const ErrorMediaIdentifier

+ const FormatCIDR

+ const FormatDateTime

+ const FormatEmail

+ const FormatHostname

+ const FormatIP

+ const FormatIPv4

+ const FormatIPv6

+ const FormatMAC

+ const FormatRegexp

+ const FormatURI

+ const FormatUUID

+ var ErrBadRequest = NewErrorClass("bad_request", 400)

+ var ErrInternal = NewErrorClass("internal", 500)

+ var ErrInvalidEncoding = NewErrorClass("invalid_encoding", 400)

+ var ErrInvalidFile = NewErrorClass("invalid_file", 404)

+ var ErrInvalidRequest = NewErrorClass("invalid_request", 400)

+ var ErrNoAuthMiddleware = NewErrorClass("no_auth_middleware", 500)

+ var ErrNotFound = NewErrorClass("not_found", 404)

+ var ErrRequestBodyTooLarge = NewErrorClass("request_too_large", 413)

+ var ErrUnauthorized = NewErrorClass("unauthorized", 401)

+ func AddSample(key []string, val float32) — darwin/amd64, linux/amd64, windows/amd64

+ func ContextAction(ctx context.Context) string

+ func ContextController(ctx context.Context) string

+ func ContextError(ctx context.Context) error

+ func ContextRequiredScopes(ctx context.Context) []string

+ func EmitKey(key []string, val float32) — darwin/amd64, linux/amd64, windows/amd64

+ func IncrCounter(key []string, val float32)

+ func InvalidAttributeTypeError(ctx string, val interface{}, expected string) error

+ func InvalidEnumValueError(ctx string, val interface{}, allowed []interface{}) error

+ func InvalidFormatError(ctx, target string, format Format, formatError error) error

+ func InvalidLengthError(ctx string, target interface{}, ln, value int, min bool) error

+ func InvalidParamTypeError(name string, val interface{}, expected string) error

+ func InvalidPatternError(ctx, target string, pattern string) error

+ func InvalidRangeError(ctx string, target interface{}, value int, min bool) error

+ func LogError(ctx context.Context, msg string, keyvals ...interface{})

+ func LogInfo(ctx context.Context, msg string, keyvals ...interface{})

+ func Logger(ctx context.Context) *log.Logger

+ func MeasureSince(key []string, start time.Time)

+ func MergeErrors(err, other error) error

+ func MissingAttributeError(ctx, name string) error

+ func MissingHeaderError(name string) error

+ func MissingParamError(name string) error

+ func MissingPayloadError() error

+ func NewContext(ctx context.Context, rw http.ResponseWriter, req *http.Request, ...) context.Context

+ func NewMetrics(conf *metrics.Config, sink metrics.MetricSink) (err error) — darwin/amd64, linux/amd64, windows/amd64

+ func NoAuthMiddleware(schemeName string) error

+ func SetGauge(key []string, val float32) — darwin/amd64, linux/amd64, windows/amd64

+ func ValidateFormat(f Format, val string) error

+ func ValidatePattern(p string, val string) bool

+ func WithAction(ctx context.Context, action string) context.Context

+ func WithError(ctx context.Context, err error) context.Context

+ func WithLogContext(ctx context.Context, keyvals ...interface{}) context.Context

+ func WithLogger(ctx context.Context, logger LogAdapter) context.Context

+ func WithRequiredScopes(ctx context.Context, scopes []string) context.Context

+ type APIKeySecurity struct

+ Description string

+ In Location

+ Name string

+ type BasicAuthSecurity struct

+ Description string

+ type Controller struct

+ Context context.Context

+ MaxRequestBodyLength int64

+ Name string

+ Service *Service

+ func (ctrl *Controller) FileHandler(path, filename string) Handler

+ func (ctrl *Controller) MuxHandler(name string, hdlr Handler, unm Unmarshaler) MuxHandler

+ func (ctrl *Controller) ServeFiles(path, filename string) error

+ func (ctrl *Controller) Use(m Middleware)

+ type DecodeFunc func(context.Context, io.ReadCloser, interface{}) error

+ type Decoder interface

+ Decode func(v interface{}) error

+ func NewGobDecoder(r io.Reader) Decoder

+ func NewJSONDecoder(r io.Reader) Decoder

+ func NewXMLDecoder(r io.Reader) Decoder

+ type DecoderFunc func(r io.Reader) Decoder

+ type Encoder interface

+ Encode func(v interface{}) error

+ func NewGobEncoder(w io.Writer) Encoder

+ func NewJSONEncoder(w io.Writer) Encoder

+ func NewXMLEncoder(w io.Writer) Encoder

+ type EncoderFunc func(w io.Writer) Encoder

+ type ErrorClass func(message interface{}, keyvals ...interface{}) error

+ func NewErrorClass(code string, status int) ErrorClass

+ type ErrorResponse struct

+ Code string

+ Detail string

+ ID string

+ Meta []map[string]interface{}

+ Status int

+ func (e *ErrorResponse) Error() string

+ func (e *ErrorResponse) ResponseStatus() int

+ func (e *ErrorResponse) Token() string

+ type FileServer interface

+ FileHandler func(path, filename string) Handler

+ type Format string

+ type HTTPDecoder struct

+ func NewHTTPDecoder() *HTTPDecoder

+ func (decoder *HTTPDecoder) Decode(v interface{}, body io.Reader, contentType string) error

+ func (decoder *HTTPDecoder) Register(f DecoderFunc, contentTypes ...string)

+ type HTTPEncoder struct

+ func NewHTTPEncoder() *HTTPEncoder

+ func (encoder *HTTPEncoder) Encode(v interface{}, resp io.Writer, accept string) error

+ func (encoder *HTTPEncoder) Register(f EncoderFunc, contentTypes ...string)

+ type Handler func(context.Context, http.ResponseWriter, *http.Request) error

+ type JWTSecurity struct

+ Description string

+ In Location

+ Name string

+ Scopes map[string]string

+ TokenURL string

+ type Location string

+ const LocHeader

+ const LocQuery

+ type LogAdapter interface

+ Error func(msg string, keyvals ...interface{})

+ Info func(msg string, keyvals ...interface{})

+ New func(keyvals ...interface{}) LogAdapter

+ func ContextLogger(ctx context.Context) LogAdapter

+ func NewLogger(logger *log.Logger) LogAdapter

+ type Middleware func(Handler) Handler

+ func NewMiddleware(m interface{}) (mw Middleware, err error)

+ type MuxHandler func(http.ResponseWriter, *http.Request, url.Values)

+ type Muxer interface

+ MuxHandler func(string, Handler, Unmarshaler) MuxHandler

+ type OAuth2Security struct

+ AuthorizationURL string

+ Description string

+ Flow string

+ Scopes map[string]string

+ TokenURL string

+ type RequestData struct

+ Params url.Values

+ Payload interface{}

+ func ContextRequest(ctx context.Context) *RequestData

+ type ResettableDecoder interface

+ Reset func(r io.Reader)

+ type ResettableEncoder interface

+ Reset func(w io.Writer)

+ type ResponseData struct

+ ErrorCode string

+ Length int

+ Service *Service

+ Status int

+ func ContextResponse(ctx context.Context) *ResponseData

+ func (r *ResponseData) SwitchWriter(rw http.ResponseWriter) http.ResponseWriter

+ func (r *ResponseData) Write(b []byte) (int, error)

+ func (r *ResponseData) WriteHeader(status int)

+ func (r *ResponseData) Written() bool

+ type ServeMux interface

+ Handle func(method, path string, handle MuxHandler)

+ HandleNotFound func(handle MuxHandler)

+ Lookup func(method, path string) MuxHandler

+ func NewMux() ServeMux

+ type Service struct

+ Context context.Context

+ Decoder *HTTPDecoder

+ Encoder *HTTPEncoder

+ Mux ServeMux

+ Name string

+ func New(name string) *Service

+ func (service *Service) CancelAll()

+ func (service *Service) DecodeRequest(req *http.Request, v interface{}) error

+ func (service *Service) EncodeResponse(ctx context.Context, v interface{}) error

+ func (service *Service) ListenAndServe(addr string) error

+ func (service *Service) ListenAndServeTLS(addr, certFile, keyFile string) error

+ func (service *Service) LogError(msg string, keyvals ...interface{})

+ func (service *Service) LogInfo(msg string, keyvals ...interface{})

+ func (service *Service) NewController(name string) *Controller

+ func (service *Service) Send(ctx context.Context, code int, body interface{}) error

+ func (service *Service) ServeFiles(path, filename string) error

+ func (service *Service) Use(m Middleware)

+ func (service *Service) WithLogger(logger LogAdapter)

+ type ServiceError interface

+ ResponseStatus func() int

+ Token func() string

+ type Unmarshaler func(context.Context, *Service, *http.Request) error