statuscodes

Documentation

Overview

Package statuscodes provides custom status types and helpers

Index

• type StatusCategory
  • func (i StatusCategory) String() string
• type StatusCode
  • func FromString(s string) (StatusCode, bool)
  • func (re StatusCode) Category() StatusCategory
  • func (i StatusCode) String() string
  • func (re *StatusCode) UnmarshalText(text []byte) error

Types

type StatusCategory

type StatusCategory int

const (
	CategoryOK          StatusCategory = 1
	CategoryClientError StatusCategory = 2
	CategoryServerError StatusCategory = 3
)

func (StatusCategory) String

func (i StatusCategory) String() string

type StatusCode

type StatusCode int

const (
	OK StatusCode = 600

	// Client-caused error responses
	BadRequest   StatusCode = 700
	Unauthorized StatusCode = 701
	Forbidden    StatusCode = 702
	NotFound     StatusCode = 703
	Conflict     StatusCode = 704
	RateLimited  StatusCode = 705

	// Server-caused error responses
	InternalServerError StatusCode = 800
	NotImplemented      StatusCode = 801
	Unavailable         StatusCode = 802
	UnknownError        StatusCode = 803
)

1. Keep OK not as zero so you know someone affirmatively picked it 2. Don't overlap with HTTP error codes so people know that these are different

func FromString

func FromString(s string) (StatusCode, bool)

func (StatusCode) Category

func (re StatusCode) Category() StatusCategory

func (StatusCode) String

func (i StatusCode) String() string

func (*StatusCode) UnmarshalText

func (re *StatusCode) UnmarshalText(text []byte) error