response

Documentation

Index

• func AppendResponseToContext(ctx context.Context, r *Response) context.Context
• func Decode(value []byte, out any) error
• func SetResponseCode(ctx context.Context, code int)
• func Zero(value interface{})
• type Field
• type Options
• type Response
  • func NewFromEcho(ctx echo.Context, options *Options) *Response
  • func NewFromFasthttp(ctx *fasthttp.RequestCtx, options *Options) *Response
  • func RetrieveFromContext(ctx context.Context) *Response
  • func (r *Response) ForwardAuthenticationError(err error) error
  • func (r *Response) ForwardError(err error) error
  • func (r *Response) ForwardSuccess(data interface{}) error
  • func (r *Response) SetContentType(contentType string)
• type ResponserEcho
• type ResponserFasthttp

Functions

func AppendResponseToContext

func AppendResponseToContext(ctx context.Context, r *Response) context.Context

func Decode

func Decode(value []byte, out any) error

Decode is a helper function that translates a byte slice into a target by converting its type.

func SetResponseCode

func SetResponseCode(ctx context.Context, code int)

func Zero

func Zero(value interface{})

Zero clears the value of the argument to its zero value according its type.

Types

type Field

type Field struct {
	Field    string `json:"field,omitempty"`
	Message  string `json:"message,omitempty"`
	Location string `json:"location,omitempty"`
}

type Options

type Options struct {
	ServiceName string
}

type Response

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

func NewFromEcho

func NewFromEcho(ctx echo.Context, options *Options) *Response

func NewFromFasthttp

func NewFromFasthttp(ctx *fasthttp.RequestCtx, options *Options) *Response

NewFromFasthttp creates a new response container for HTTP handlers return data using a specific standard.

func RetrieveFromContext

func RetrieveFromContext(ctx context.Context) *Response

func (*Response) ForwardAuthenticationError

func (r *Response) ForwardAuthenticationError(err error) error

func (*Response) ForwardError

func (r *Response) ForwardError(err error) error

func (*Response) ForwardSuccess

func (r *Response) ForwardSuccess(data interface{}) error

func (*Response) SetContentType

func (r *Response) SetContentType(contentType string)

type ResponserEcho

type ResponserEcho interface {
	HttpResponseBytes() ([]byte, error)
}

type ResponserFasthttp

type ResponserFasthttp interface {
	HttpResponse() interface{}
}

ResponserFasthttp is a behavior that a struct may have to format its fields in case of an HTTP response.