app

Documentation

Index

• type JSON
• type PB
  • func (*PB) ProtoMessage()
  • func (m *PB) Reset()
  • func (m *PB) String() string
• type Response
  • func NewResponse(c *gin.Context) *Response
  • func (c *Response) JSON(data interface{}, err error)
  • func (c *Response) JSONMap(data map[string]interface{}, err error)
  • func (c *Response) MustBindHEADER(obj interface{}) (err error)
  • func (c *Response) MustBindJSON(obj interface{}) (err error)
  • func (c *Response) MustBindQUERY(obj interface{}) (err error)
  • func (c *Response) MustBindURI(obj interface{}) (err error)
  • func (c *Response) MustBindWith(obj interface{}, b binding.Binding) (err error)
  • func (c *Response) MustBindXML(obj interface{}) (err error)
  • func (c *Response) MustBindYAML(obj interface{}) (err error)
  • func (c *Response) Protobuf(data proto.Message, err error)
  • func (c *Response) XML(data interface{}, err error)
• type XML

Types

type JSON

type JSON struct {
	Code    int         `json:"code"`
	Message string      `json:"message"`
	TTL     int         `json:"ttl"`
	Data    interface{} `json:"data,omitempty"`
}

JSON common json struct.

type PB

type PB struct {
	Code    int64                `protobuf:"varint,1,opt,name=Code,proto3" json:"Code,omitempty"`
	Message string               `protobuf:"bytes,2,opt,name=Message,proto3" json:"Message,omitempty"`
	TTL     uint64               `protobuf:"varint,3,opt,name=TTL,proto3" json:"TTL,omitempty"`
	Data    *google_protobuf.Any `protobuf:"bytes,4,opt,name=Data" json:"Data,omitempty"`
}

func (*PB) ProtoMessage

func (*PB) ProtoMessage()

func (*PB) Reset

func (m *PB) Reset()

func (*PB) String

func (m *PB) String() string

type Response

type Response struct {
	*gin.Context
}

func NewResponse

func NewResponse(c *gin.Context) *Response

func (*Response) JSON

func (c *Response) JSON(data interface{}, err error)

JSON serializes the given struct as JSON into the response body. It also sets the Content-Type as "application/json".

func (*Response) JSONMap

func (c *Response) JSONMap(data map[string]interface{}, err error)

JSONMap serializes the given map as map JSON into the response body. It also sets the Content-Type as "application/json".

func (*Response) MustBindHEADER

func (c *Response) MustBindHEADER(obj interface{}) (err error)

func (*Response) MustBindJSON

func (c *Response) MustBindJSON(obj interface{}) (err error)

func (*Response) MustBindQUERY

func (c *Response) MustBindQUERY(obj interface{}) (err error)

func (*Response) MustBindURI

func (c *Response) MustBindURI(obj interface{}) (err error)

func (*Response) MustBindWith

func (c *Response) MustBindWith(obj interface{}, b binding.Binding) (err error)

MustBindWith binds the passed struct pointer using the specified binding engine. It will abort the request with HTTP 400 if any error ocurrs. See the binding package.

func (*Response) MustBindXML

func (c *Response) MustBindXML(obj interface{}) (err error)

func (*Response) MustBindYAML

func (c *Response) MustBindYAML(obj interface{}) (err error)

func (*Response) Protobuf

func (c *Response) Protobuf(data proto.Message, err error)

Protobuf serializes the given struct as PB into the response body. It also sets the ContentType as "application/x-protobuf".

func (*Response) XML

func (c *Response) XML(data interface{}, err error)

XML serializes the given struct as XML into the response body. It also sets the Content-Type as "application/xml".

type XML

type XML struct {
	Code    int
	Message string
	Data    interface{}
}

XML common xml struct.