envelope

Documentation

Index

• type Envelope
  • func GetEnvelopeAndLogger(r *http.Request) (*Envelope, logging.Writer, apierror.HTTPError)
  • func New() *Envelope
  • func ReadEnvelope(r *http.Request) *Envelope
  • func (e *Envelope) Finish(w http.ResponseWriter, r *http.Request, logger logging.Writer)
  • func (e *Envelope) Render(w http.ResponseWriter, r *http.Request) error
  • func (e *Envelope) SetError(err apierror.HTTPError) *Envelope
  • func (e *Envelope) SetPagination(p params.Pagination) *Envelope
  • func (e *Envelope) SetResponse(resp any) *Envelope
  • func (e *Envelope) SetSuccess() *Envelope

Types

type Envelope

type Envelope struct {
	Success        bool               `json:"success"`
	RequestID      string             `json:"request_id"`
	Time           string             `json:"time"`
	Data           any                `json:"data"`
	Error          string             `json:"error,omitempty"`
	Errors         []string           `json:"errors,omitempty"`
	Message        string             `json:"message,omitempty"`
	HTTPStatusCode int                `json:"-"`
	Pagination     *params.Pagination `json:"pagination,omitempty"`
}

func GetEnvelopeAndLogger

func GetEnvelopeAndLogger(r *http.Request) (*Envelope, logging.Writer, apierror.HTTPError)

func New

func New() *Envelope

func ReadEnvelope

func ReadEnvelope(r *http.Request) *Envelope

func (*Envelope) Finish

func (e *Envelope) Finish(w http.ResponseWriter, r *http.Request, logger logging.Writer)

func (*Envelope) Render

func (e *Envelope) Render(w http.ResponseWriter, r *http.Request) error

func (*Envelope) SetError

func (e *Envelope) SetError(err apierror.HTTPError) *Envelope

func (*Envelope) SetPagination

func (e *Envelope) SetPagination(p params.Pagination) *Envelope

func (*Envelope) SetResponse

func (e *Envelope) SetResponse(resp any) *Envelope

func (*Envelope) SetSuccess

func (e *Envelope) SetSuccess() *Envelope