Skip to content

errors

import "github.com/iolave/go-proxmox/pkg/errors"

type HTTPError

type HTTPError struct {
    StatusCode int         `json:"statusCode"` // response status code
    Name       string      `json:"name"`       // name related to the given StatusCode
    Message    string      `json:"message"`    // user defined message
    Original   interface{} `json:"original"`   // original body from an http response
}

func NewHTTPError

func NewHTTPError(code int, message string, err any) *HTTPError

NewHTTPError returns a new initialized HTTPError.

func NewHTTPErrorFromResponse

func NewHTTPErrorFromResponse(res *http.Response) *HTTPError

NewHTTPErrorFromResponse returns a new HTTPError based in a http.Response.

  • It maps the response body to the HTTPError.Original property.
  • It maps the response status to the HTTPError.Message.
  • If it fails to read the response body, the HTTPError.Message will reflect it.

func (HTTPError) Error

func (err HTTPError) Error() string

Error returns the HTTPError.Message property.

func (HTTPError) Marshall

func (e HTTPError) Marshall() ([]byte, error)

Marshall converts an HTTPError to json.

func (HTTPError) WriteResponse

func (e HTTPError) WriteResponse(w http.ResponseWriter) error

WriteResponse writes to the sender an HTTPError in json format.