httperror

Documentation

Index

• type APIError
  • func (err *APIError) Error() string
  • func (err *APIError) IsMissing() bool
  • func (err *APIError) IsUnavailable() bool

Types

type APIError

type APIError struct {
	StatusCode int
	Status     string
	Body       string
}

When an API call fails, we may want to distinguish among the causes by status code. This type can be used as the base error when we get a non-"HTTP 20x" response, retrievable with errors.Cause(err).

func (*APIError) Error

func (err *APIError) Error() string

func (*APIError) IsMissing

func (err *APIError) IsMissing() bool

Is this API call missing? This usually indicates that there is a version mismatch between the client and the service.

func (*APIError) IsUnavailable

func (err *APIError) IsUnavailable() bool

Does this error mean the API service is unavailable?