♻️ Use standard getter/setter names

This commit is contained in:
Dan Jones 2024-01-19 22:37:13 -06:00
commit f27c669aeb
5 changed files with 41 additions and 37 deletions

View file

@ -3,25 +3,29 @@ package errors
// ResponsableError is an error that has information useful in an HTTP response.
// The string returned by Error should be suitable for logging useful information
// to assist debugging the error.
// GetStatus should return an appropriate HTTP status.
// GetMsg should return a message suitable to display to the end user. If the message
//
// Status should return an appropriate HTTP status. It must not return < 100 || >= 600.
//
// Msg should return a message suitable to display to the end user. If the message
// returned by Error is safe for the end user, it may simply call that.
// GetStatus should not return a value outside of the 100 - 599 range.
type ResponsableError interface {
Error() string
GetStatus() int
GetMsg() string
Status() int
Msg() string
}
// SettableError is a ResponsableError which can be modified after initial creation.
// The Status method can set the status, while the Msg method can set user message.
//
// The SetStatus method can set the status, while the SetMsg method can set user message.
// If any values are passed after the message, it should be passed to fmt.Sprintf for formatting.
//
// Methods are chainable.
//
// SetStatus should not use a value outside of 100-599. It may either ignore such values, or panic.
type SettableError interface {
ResponsableError
Status(int) SettableError
Msg(string, ...any) SettableError
SetStatus(int) SettableError
SetMsg(string, ...any) SettableError
}
// UnwrappableError allows a ResponsableError to wrap another error.