Documentation
¶
Overview ¶
This package upholds the invariants that a non-nil error may not contain an OK code, and an OK code must result in a nil error.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Code ¶
Code returns the Code of the error if it is a Status error, codes.OK if err is nil, or codes.Unknown otherwise.
func ErrorProto ¶
ErrorProto returns an error representing s. If s.Code is OK, returns nil.
Types ¶
type Status ¶
Status references google.golang.org/grpc/internal/status. It represents an RPC status code, message, and details. It is immutable and should be created with New, Newf, or FromProto.
func Convert ¶
Convert is a convenience function which removes the need to handle the boolean return value from FromError.
func FromContextError ¶
FromContextError converts a context error or wrapped context error into a Status. It returns a Status with codes.OK if err is nil, or a Status with codes.Unknown if err is non-nil and not a context error.
func FromError ¶
FromError returns a Status representation of err.
If err was produced by this package or implements the method `GRPCStatus() *Status`, the appropriate Status is returned.
If err is nil, a Status is returned with codes.OK and no message.
Otherwise, err is an error not compatible with this package. In this case, a Status is returned with codes.Unknown and err's Error() message, and ok is false.
Source Files
Directories