package status

Import Path
	google.golang.org/grpc/status (on go.dev)

Dependency Relation
	imports 5 packages, and imported by 22 packages

Involved Source Files

	   d➜ status.go
		Package status implements errors returned by gRPC.  These errors are
		serialized and transmitted on the wire between server and client, and allow
		for additional data to be transmitted via the Details field in the status
		proto.  gRPC service handlers should return an error created by this
		package, and gRPC clients should expect a corresponding error to be
		returned from the RPC call.

		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.
Package-Level Type Names (only one, which is exported)

	/* sort exporteds by: alphabet | popularity */
	 type Status = status.Status (struct)
		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.
		https://godoc.org/google.golang.org/grpc/internal/status



Package-Level Functions (total 10, all are exported)

	 func Code(err error) codes.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 Convert(err error) *Status
		Convert is a convenience function which removes the need to handle the
		boolean return value from FromError.

	 func Error(c codes.Code, msg string) error
		Error returns an error representing c and msg.  If c is OK, returns nil.

	 func Errorf(c codes.Code, format string, a ...interface{}) error
		Errorf returns Error(c, fmt.Sprintf(format, a...)).

	 func ErrorProto(s *spb.Status) error
		ErrorProto returns an error representing s.  If s.Code is OK, returns nil.

	 func FromContextError(err error) *Status
		FromContextError converts a 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(err error) (s *Status, ok bool)
		FromError returns a Status representing err if it was produced from this
		package or has a method `GRPCStatus() *Status`. Otherwise, ok is false and a
		Status is returned with codes.Unknown and the original error message.

	 func FromProto(s *spb.Status) *Status
		FromProto returns a Status representing s.

	 func New(c codes.Code, msg string) *Status
		New returns a Status representing c and msg.

	 func Newf(c codes.Code, format string, a ...interface{}) *Status
		Newf returns New(c, fmt.Sprintf(format, a...)).

The pages are generated with Golds v0.3.2-preview. (GOOS=darwin GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @Go100and1 (reachable from the left QR code) to get the latest news of Golds.