api

Documentation

Index

• Variables
• func ErrorStatusCode(err error) int
• type Error
  • func NewError(statusCode int, err error) *Error
  • func (e *Error) Error() string
  • func (e *Error) Is(err error) bool
  • func (e *Error) StatusCode() int
  • func (e *Error) Unwrap() error

Variables

var ErrAccepted error = NewError(http.StatusAccepted, fmt.Errorf("Accepted")) // 202

Partial success from AddLeaf, caller should retry.

var ErrConflict error = NewError(http.StatusConflict, fmt.Errorf("Conflict"))

Failure of witness AddTreeHead, caller should retry with correct tree size.

var ErrForbidden error = NewError(http.StatusForbidden, fmt.Errorf("Forbidden")) // 403

Unauthorized, typically because signature is invalid, or public key not recognized.

var ErrNotFound error = NewError(http.StatusNotFound, fmt.Errorf("Not Found")) // 404

E.g., GetInclusionProof fails because leaf isn't included.

var ErrTooManyRequests error = NewError(http.StatusTooManyRequests, fmt.Errorf("Too Many Requests")) // 429

Error due to exceeded rate limit.

var ErrUnprocessableEntity error = NewError(422, fmt.Errorf("Unprocessable Entity"))

Failure of witness AddTreeHead, invalid consistency proof.

Functions

func ErrorStatusCode

func ErrorStatusCode(err error) int

Types

type Error

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

An error with an associated HTTP status code.

func NewError

func NewError(statusCode int, err error) *Error

func (*Error) Error

func (e *Error) Error() string

func (*Error) Is

func (e *Error) Is(err error) bool

An error is considered matching if the status code is the same. Example usage:

if errors.Is(api.ErrNotFound, err) {...}

func (*Error) StatusCode

func (e *Error) StatusCode() int

func (*Error) Unwrap

func (e *Error) Unwrap() error