slugerr

Documentation

Overview

Package slugerr provides custom error types for the openapi HTTP API.

Index

• Variables
• type ErrorType
• type SlugError
  • func NewAuthorizationError(err string, slug string) SlugError
  • func NewIncorrectInputError(err string, slug string) SlugError
  • func NewSlugError(err string, slug string) SlugError
  • func (s SlugError) Error() string
  • func (s SlugError) ErrorType() ErrorType
  • func (s SlugError) Slug() string

Variables

var (
	// ErrorTypeUnknown defines the unknown type of error.
	ErrorTypeUnknown = ErrorType{"unknown"}
	// ErrorTypeAuthorization defines the authorization type of error.
	ErrorTypeAuthorization = ErrorType{"authorization"}
	// ErrorTypeIncorrectInput defines the incorrect input type of error.
	ErrorTypeIncorrectInput = ErrorType{"incorrect-input"}
)

Types

type ErrorType

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

ErrorType defines the type of error.

type SlugError

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

SlugError defines error for slug.

func NewAuthorizationError

func NewAuthorizationError(err string, slug string) SlugError

NewAuthorizationError creates a new authorization error.

func NewIncorrectInputError

func NewIncorrectInputError(err string, slug string) SlugError

NewIncorrectInputError creates a new incorrect input error.

func NewSlugError

func NewSlugError(err string, slug string) SlugError

NewSlugError creates a new slug error.

func (SlugError) Error

func (s SlugError) Error() string

Error returns the error message.

func (SlugError) ErrorType

func (s SlugError) ErrorType() ErrorType

ErrorType returns the error type.

func (SlugError) Slug

func (s SlugError) Slug() string

Slug returns the slug.