Add RPCError and Status #1656
Merged
Add RPCError and Status #1656
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Motivation: One mistake we made in v1 was having the status also be an error. This leads to interesting situations where a status with code 'ok' can be treated as an error. Here, we split them into two objects. Modifications: - Add a new GRPCCore target - Add RPCError and Status types and tests Result: RPCError and status are separate types.
FranzBusch
reviewed
Oct 2, 2023
| /// An error representing the outcome of an RPC. | ||
| /// | ||
| /// See also ``Status``. | ||
| public struct RPCError: @unchecked Sendable, Hashable, Error { |
There was a problem hiding this comment.
Can we add a comment why we use @unchecked here
| } | ||
| } | ||
|
|
||
| /// Metadata associated with the error. |
There was a problem hiding this comment.
Couple of questions here:
- From the proposal I remember that this includes all metadata when I receive this error on the client side right? Can we document this?
- If I throw this error on the server side will all metadata be attached to the underlying transport response? Could we also document this?
|
|
||
| /// A status object represents the outcome of an RPC. | ||
| /// | ||
| /// Each ``Status`` is composed of a ``Status/code-swift.property`` and ``Status/message``. Each |
There was a problem hiding this comment.
The first docc link is very interesting :D
There was a problem hiding this comment.
I mean this Status/code-swift.property
There was a problem hiding this comment.
Off-by-one error ;)
Yeah, docc symbols aren't case sensitive so Code-the-type and code-the-property are ambiguous otherwise.
FranzBusch
approved these changes
Oct 2, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation:
One mistake we made in v1 was having the status also be an error. This leads to interesting situations where a status with code 'ok' can be treated as an error.
Here, we split them into two objects.
Modifications:
Result:
RPCError and status are separate types.