Documentation
¶
Index ¶
- Constants
- func AlreadyExists(err error, message string) error
- func Code(err error) codes.Code
- func FailedPrecondition(err error, message string) error
- func HandlerMessage(err error) (string, bool)
- func HandlerStatus(err error) (codes.Code, string, bool)
- func Internal(err error, message string) error
- func InvalidArgument(err error, message string) error
- func NotFound(err error, message string) error
- func PermissionDenied(err error, message string) error
- func ResourceExhausted(err error, message string) error
- func StatusFromContextError(requestCtx context.Context, err error) (ok bool, statusErr error)
- func Unauthenticated(err error, message string) error
Constants ¶
const ( RequestCanceledMessage = "request canceled" RequestDeadlineExceededMessage = "request deadline exceeded" )
Variables ¶
This section is empty.
Functions ¶
func AlreadyExists ¶
AlreadyExists wraps err as an already-exists error for the grpc-gateway sanitizer.
func FailedPrecondition ¶
FailedPrecondition wraps err as a failed-precondition error for the grpc-gateway sanitizer.
func HandlerMessage ¶
HandlerMessage returns the client-safe message from a handler error.
func HandlerStatus ¶
HandlerStatus returns the gRPC code and client-safe message from a handler error.
func InvalidArgument ¶
InvalidArgument wraps err as an invalid-argument error for the grpc-gateway sanitizer.
func PermissionDenied ¶
PermissionDenied wraps err as a permission-denied error for the grpc-gateway sanitizer.
func ResourceExhausted ¶
ResourceExhausted wraps err as a resource-exhausted error for the grpc-gateway sanitizer.
func StatusFromContextError ¶
StatusFromContextError maps context cancellation errors to gRPC status codes suitable for HTTP translation via grpc-gateway:
- context.Canceled (typically client disconnect) -> codes.Canceled (HTTP 499)
- context.DeadlineExceeded -> codes.DeadlineExceeded (HTTP 504)
requestCtx should be the incoming HTTP/gRPC request context. When the client disconnects, requestCtx.Err() is set and Canceled is returned — see Brandur's notes on distinguishing local vs request context: https://brandur.org/fragments/testing-request-cancellation
func Unauthenticated ¶
Unauthenticated wraps err as an unauthenticated error for the grpc-gateway sanitizer.
Types ¶
This section is empty.