Skip to content

Note that non-OK status codes are not yet stable #149

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
csvance merged 2 commits into from
Oct 27, 2026
Merged

Note that non-OK status codes are not yet stable #149

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
509acea
Note that non-OK status codes are not yet stable
csvance Oct 27, 2026
c519628
Clarify status code changes may land in minor releases
csvance Oct 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions docs/src/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -310,6 +310,9 @@ close(rpc)

Errors surface as a [`gRPCServiceCallException`](@ref), whose `grpc_status` field carries the gRPC status code and whose `message` holds the server- or client-supplied detail.

!!! warning "Status codes other than `OK` are not yet stable"
Do not rely on the specific non-`OK` status code reported for a given failure. Some of the codes the client assigns, particularly for client-side and transport errors, may be reworked to align more closely with the gRPC reference implementations. Such corrections are considered bug fixes rather than breaking changes, so they will not require a new major version. They may ship in any minor release, but status codes will not change within patch releases. Treat any non-`OK` status as a failure, and review code that branches on a particular status when upgrading to a new minor version.

Where the exception is raised depends on how the call is driven:

- A **synchronous unary** call raises from the call itself, so wrap `TestService.TestRPC(chan, req)` in a `try`/`catch`.
Expand Down
Loading