helpers.go 5.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279
  1. package errdefs
  2. import "context"
  3. type errNotFound struct{ error }
  4. func (errNotFound) NotFound() {}
  5. func (e errNotFound) Cause() error {
  6. return e.error
  7. }
  8. func (e errNotFound) Unwrap() error {
  9. return e.error
  10. }
  11. // NotFound is a helper to create an error of the class with the same name from any error type
  12. func NotFound(err error) error {
  13. if err == nil || IsNotFound(err) {
  14. return err
  15. }
  16. return errNotFound{err}
  17. }
  18. type errInvalidParameter struct{ error }
  19. func (errInvalidParameter) InvalidParameter() {}
  20. func (e errInvalidParameter) Cause() error {
  21. return e.error
  22. }
  23. func (e errInvalidParameter) Unwrap() error {
  24. return e.error
  25. }
  26. // InvalidParameter is a helper to create an error of the class with the same name from any error type
  27. func InvalidParameter(err error) error {
  28. if err == nil || IsInvalidParameter(err) {
  29. return err
  30. }
  31. return errInvalidParameter{err}
  32. }
  33. type errConflict struct{ error }
  34. func (errConflict) Conflict() {}
  35. func (e errConflict) Cause() error {
  36. return e.error
  37. }
  38. func (e errConflict) Unwrap() error {
  39. return e.error
  40. }
  41. // Conflict is a helper to create an error of the class with the same name from any error type
  42. func Conflict(err error) error {
  43. if err == nil || IsConflict(err) {
  44. return err
  45. }
  46. return errConflict{err}
  47. }
  48. type errUnauthorized struct{ error }
  49. func (errUnauthorized) Unauthorized() {}
  50. func (e errUnauthorized) Cause() error {
  51. return e.error
  52. }
  53. func (e errUnauthorized) Unwrap() error {
  54. return e.error
  55. }
  56. // Unauthorized is a helper to create an error of the class with the same name from any error type
  57. func Unauthorized(err error) error {
  58. if err == nil || IsUnauthorized(err) {
  59. return err
  60. }
  61. return errUnauthorized{err}
  62. }
  63. type errUnavailable struct{ error }
  64. func (errUnavailable) Unavailable() {}
  65. func (e errUnavailable) Cause() error {
  66. return e.error
  67. }
  68. func (e errUnavailable) Unwrap() error {
  69. return e.error
  70. }
  71. // Unavailable is a helper to create an error of the class with the same name from any error type
  72. func Unavailable(err error) error {
  73. if err == nil || IsUnavailable(err) {
  74. return err
  75. }
  76. return errUnavailable{err}
  77. }
  78. type errForbidden struct{ error }
  79. func (errForbidden) Forbidden() {}
  80. func (e errForbidden) Cause() error {
  81. return e.error
  82. }
  83. func (e errForbidden) Unwrap() error {
  84. return e.error
  85. }
  86. // Forbidden is a helper to create an error of the class with the same name from any error type
  87. func Forbidden(err error) error {
  88. if err == nil || IsForbidden(err) {
  89. return err
  90. }
  91. return errForbidden{err}
  92. }
  93. type errSystem struct{ error }
  94. func (errSystem) System() {}
  95. func (e errSystem) Cause() error {
  96. return e.error
  97. }
  98. func (e errSystem) Unwrap() error {
  99. return e.error
  100. }
  101. // System is a helper to create an error of the class with the same name from any error type
  102. func System(err error) error {
  103. if err == nil || IsSystem(err) {
  104. return err
  105. }
  106. return errSystem{err}
  107. }
  108. type errNotModified struct{ error }
  109. func (errNotModified) NotModified() {}
  110. func (e errNotModified) Cause() error {
  111. return e.error
  112. }
  113. func (e errNotModified) Unwrap() error {
  114. return e.error
  115. }
  116. // NotModified is a helper to create an error of the class with the same name from any error type
  117. func NotModified(err error) error {
  118. if err == nil || IsNotModified(err) {
  119. return err
  120. }
  121. return errNotModified{err}
  122. }
  123. type errNotImplemented struct{ error }
  124. func (errNotImplemented) NotImplemented() {}
  125. func (e errNotImplemented) Cause() error {
  126. return e.error
  127. }
  128. func (e errNotImplemented) Unwrap() error {
  129. return e.error
  130. }
  131. // NotImplemented is a helper to create an error of the class with the same name from any error type
  132. func NotImplemented(err error) error {
  133. if err == nil || IsNotImplemented(err) {
  134. return err
  135. }
  136. return errNotImplemented{err}
  137. }
  138. type errUnknown struct{ error }
  139. func (errUnknown) Unknown() {}
  140. func (e errUnknown) Cause() error {
  141. return e.error
  142. }
  143. func (e errUnknown) Unwrap() error {
  144. return e.error
  145. }
  146. // Unknown is a helper to create an error of the class with the same name from any error type
  147. func Unknown(err error) error {
  148. if err == nil || IsUnknown(err) {
  149. return err
  150. }
  151. return errUnknown{err}
  152. }
  153. type errCancelled struct{ error }
  154. func (errCancelled) Cancelled() {}
  155. func (e errCancelled) Cause() error {
  156. return e.error
  157. }
  158. func (e errCancelled) Unwrap() error {
  159. return e.error
  160. }
  161. // Cancelled is a helper to create an error of the class with the same name from any error type
  162. func Cancelled(err error) error {
  163. if err == nil || IsCancelled(err) {
  164. return err
  165. }
  166. return errCancelled{err}
  167. }
  168. type errDeadline struct{ error }
  169. func (errDeadline) DeadlineExceeded() {}
  170. func (e errDeadline) Cause() error {
  171. return e.error
  172. }
  173. func (e errDeadline) Unwrap() error {
  174. return e.error
  175. }
  176. // Deadline is a helper to create an error of the class with the same name from any error type
  177. func Deadline(err error) error {
  178. if err == nil || IsDeadline(err) {
  179. return err
  180. }
  181. return errDeadline{err}
  182. }
  183. type errDataLoss struct{ error }
  184. func (errDataLoss) DataLoss() {}
  185. func (e errDataLoss) Cause() error {
  186. return e.error
  187. }
  188. func (e errDataLoss) Unwrap() error {
  189. return e.error
  190. }
  191. // DataLoss is a helper to create an error of the class with the same name from any error type
  192. func DataLoss(err error) error {
  193. if err == nil || IsDataLoss(err) {
  194. return err
  195. }
  196. return errDataLoss{err}
  197. }
  198. // FromContext returns the error class from the passed in context
  199. func FromContext(ctx context.Context) error {
  200. e := ctx.Err()
  201. if e == nil {
  202. return nil
  203. }
  204. if e == context.Canceled {
  205. return Cancelled(e)
  206. }
  207. if e == context.DeadlineExceeded {
  208. return Deadline(e)
  209. }
  210. return Unknown(e)
  211. }