encoder

README

Encoder.

This is a simple wrapper to the json.Marshal, which adds ability to skip some fields of structure.
Unlike 'render' package it doesn't write anything, just returns marshalled data.
It's useful for things like passwords, statuses, activation codes, etc...

E.g.:

type Some struct {
	Login    string        `json:"login"`
	Password string        `json:"password,omitempty"  out:"false"`
}

Field 'Password' won't be exported.

Documentation

Index

• func Must(data []byte, err error) []byte
• type Encoder
• type JsonEncoder
  • func (_ JsonEncoder) Encode(v ...interface{}) ([]byte, error)

Functions

func Must

func Must(data []byte, err error) []byte

Because `panic`s are caught by martini's Recovery handler, it can be used to return server-side errors (500). Some helpful text message should probably be sent, although not the technical error (which is printed in the log).

Types

type Encoder

type Encoder interface {
	Encode(v ...interface{}) ([]byte, error)
}

An Encoder implements an encoding format of values to be sent as response to requests on the API endpoints.

type JsonEncoder

type JsonEncoder struct{}

func (JsonEncoder) Encode

func (_ JsonEncoder) Encode(v ...interface{}) ([]byte, error)

jsonEncoder is an Encoder that produces JSON-formatted responses.