common

Documentation

Index

• Constants
• type ApiHandlerFunc
• type PermissionState
  • func NewPermissionState() *PermissionState
  • func (ps *PermissionState) Grant()
• type PermissionStatus
• type Response
  • func NewJsonResponse(status int, body any, headers map[string][]string) Response
• type RuntimeError
  • func NewAuthenticationFailedErr() RuntimeError
  • func NewAuthenticationFailedMessageErr(message string) RuntimeError
  • func NewForeignKeyConstraintError(column string) RuntimeError
  • func NewHttpMethodNotAllowedError(message string) RuntimeError
  • func NewInputMalformedError(message string) RuntimeError
  • func NewMethodNotFoundError() RuntimeError
  • func NewNotFoundError() RuntimeError
  • func NewNotNullError(column string) RuntimeError
  • func NewPermissionError() RuntimeError
  • func NewUniquenessError(columns []string) RuntimeError
  • func NewValidationError(message string) RuntimeError
  • func (r RuntimeError) Error() string
  • func (r RuntimeError) Extensions() map[string]any

Constants

const (
	// An unexpected internal error happened.
	ErrInternal = "ERR_INTERNAL"
	// The input arguments provided are not valid.
	ErrInvalidInput = "ERR_INVALID_INPUT"
	// The input provided is malformed and cannot be parsed.
	ErrInputMalformed = "ERR_INPUT_MALFORMED"
	// Authentication failed when trying to identify the identity.
	ErrAuthenticationFailed = "ERR_AUTHENTICATION_FAILED"
	// Permission denied when trying to access some resource.
	ErrPermissionDenied = "ERR_PERMISSION_DENIED"
	// Record cannot be found with the provided parameters.
	ErrRecordNotFound = "ERR_RECORD_NOT_FOUND"
	// The path or action does not exist.
	ErrMethodNotFound = "ERR_ACTION_NOT_FOUND"
	// The HTTP method is not allowed for this request.
	ErrHttpMethodNotAllowed = "ERR_HTTP_METHOD_NOT_ALLOWED"
)

Types

type ApiHandlerFunc

type ApiHandlerFunc func(r *http.Request) Response

type PermissionState

type PermissionState struct {
	Status PermissionStatus `json:"status"`
}

func NewPermissionState

func NewPermissionState() *PermissionState

func (*PermissionState) Grant

func (ps *PermissionState) Grant()

type PermissionStatus

type PermissionStatus string

const (
	PermissionGranted PermissionStatus = "granted"
	PermissionUnknown PermissionStatus = "unknown"
)

type Response

type Response struct {
	Status  int
	Body    []byte
	Headers map[string][]string
}

func NewJsonResponse

func NewJsonResponse(status int, body any, headers map[string][]string) Response

type RuntimeError

type RuntimeError struct {
	Code    string
	Message string
}

func NewAuthenticationFailedErr

func NewAuthenticationFailedErr() RuntimeError

func NewAuthenticationFailedMessageErr

func NewAuthenticationFailedMessageErr(message string) RuntimeError

func NewForeignKeyConstraintError

func NewForeignKeyConstraintError(column string) RuntimeError

func NewHttpMethodNotAllowedError

func NewHttpMethodNotAllowedError(message string) RuntimeError

func NewInputMalformedError

func NewInputMalformedError(message string) RuntimeError

func NewMethodNotFoundError

func NewMethodNotFoundError() RuntimeError

func NewNotFoundError

func NewNotFoundError() RuntimeError

func NewNotNullError

func NewNotNullError(column string) RuntimeError

func NewPermissionError

func NewPermissionError() RuntimeError

func NewUniquenessError

func NewUniquenessError(columns []string) RuntimeError

func NewValidationError

func NewValidationError(message string) RuntimeError

func (RuntimeError) Error

func (r RuntimeError) Error() string

func (RuntimeError) Extensions

func (r RuntimeError) Extensions() map[string]any