errors

Documentation

Overview

Package errors defines the domain errors for the board.

The CLI renders them as "error: <message>" and exits non-zero. Keeping a small typed error set means the core stays a plain library.

Index

• type BoardError
  • func As(err error) (BoardError, bool)
  • func Conflict(message string) BoardError
  • func Invalid(message string) BoardError
  • func NotFound(message string) BoardError

Types

type BoardError

type BoardError interface {
	error
	Code() string
	Message() string
}

BoardError is the interface implemented by all board errors. Each carries a short machine code and a human message.

func As

func As(err error) (BoardError, bool)

As reports whether err is a BoardError, returning it if so.

func Conflict

func Conflict(message string) BoardError

Conflict: the operation is illegal in the current state (e.g. a bad transition).

func Invalid

func Invalid(message string) BoardError

Invalid: the request itself is malformed (e.g. an unknown status).

func NotFound

func NotFound(message string) BoardError

NotFound: a task or board could not be found.