https://github.com/gogo/status

gRPC-like status package for use with GoGo Protobuf types
https://github.com/gogo/status

gogoproto grpc protobuf

Last synced: 2 months ago
JSON representation

gRPC-like status package for use with GoGo Protobuf types

• Host: GitHub
• URL: https://github.com/gogo/status
• Owner: gogo
• License: apache-2.0
• Created: 2018-03-18T18:00:03.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2022-06-15T02:25:43.000Z (over 2 years ago)
• Last Synced: 2024-11-15T07:59:42.178Z (2 months ago)
• Topics: gogoproto, grpc, protobuf
• Language: Go
• Homepage:
• Size: 17.6 KB
• Stars: 13
• Watchers: 3
• Forks: 7
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Status

This is a convenience package for users of `gogo/protobuf` to be able to use

their `gogo/protobuf` generated message easily and transparently with the

gRPC status error structure.

It requires [Go gRPC version 1.11](https://github.com/grpc/grpc-go/releases/tag/v1.11.0)

or above to successfully transmit statuses over the gRPC transport.

## Use

Use as you would the normal `grpc/status` package:

```go

return status.Error(codes.NotFound, "no such user")

```

```go

st := status.New(codes.FailedPrecondition, "wrong user role")

detSt, err := st.WithDetails(&rpc.BadRequest{

    FieldViolations: []*rpc.BadRequest_FieldViolation{

        {

            Field:       "role",

            Description: "The first user created must have the role of an ADMIN",

        },

    },

})

if err == nil {

    return detSt.Err()

}

return st.Err()

```

## License

The code is 95% copied from the official gRPC status package, so the gRPC

License applies.

### Changes

The changes applied include changing the use of the

`golang/protobuf` packages to `gogo/protobuf`, and changing the

generated files from `google.golang.org/genproto/googleapis` to

`github.com/gogo/googleapis/`.

We've also created an implicit interface fulfilled by all `gogo/status`

errors, for use with `grpc/status` and the gRPC runtime libraries.