grpcerror

gRPC error

⭐ Star us on GitHub — it motivates us a lot!

gRPC error library for Go/Golang.

If you are a server developer, you should generate errors with enough information to help client developers understand and resolve the problem.

Table of Content

• Error Payloads
• Usage/Examples
  • NewNotFoundError
• License
• Links

Error Payloads

The google.rpc package defines a set of standard error payloads, which are preferred to custom error payloads. The following table lists each error code and its matching standard error payload, if applicable. We recommend advanced applications look for these error payloads in google.rpc.Status when they handle errors.

Usage/Examples

NewNotFoundError

package main

import (
	"google.golang.org/genproto/googleapis/rpc/errdetails"

	"github.com/LipsarHQ/go-grpc-error"
)

func main() {
	// ...
	if err != nil {
		// Return error in case of resource not found.
		return nil, grpcerror.NewNotFoundError(&errdetails.ResourceInfo{
			ResourceType: "", // string(new(examplepb.Example).ProtoReflect().Descriptor().FullName())
			ResourceName: "", // ID.
			Owner:        "", // ID.
			Description:  err.Error(),
		})
	}
}

License

MIT

Links

• Google Cloud API design guide
  • Error Payloads