Add comments/docs

grpc · Oct 2, 2023 · 891bf7f · 891bf7f
1 parent d482206
commit 891bf7f
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/Sources/GRPCCore/RPCError.swift b/Sources/GRPCCore/RPCError.swift
@@ -18,6 +18,8 @@
 ///
 /// See also ``Status``.
 public struct RPCError: @unchecked Sendable, Hashable, Error {
+  // @unchecked because it relies on heap allocated storage and 'isKnownUniquelyReferenced'
+
   private var storage: Storage
   private mutating func ensureStorageIsUnique() {
     if !isKnownUniquelyReferenced(&self.storage) {
@@ -44,6 +46,11 @@ public struct RPCError: @unchecked Sendable, Hashable, Error {
   }
 
   /// Metadata associated with the error.
+  ///
+  /// Any metadata included in the error thrown from a service will be sent back to the client and
+  /// conversely any ``RPCError`` received by the client may include metadata sent by a service.
+  ///
+  /// Note that clients and servers may synthesise errors which may not include metadata.
   public var metadata: Metadata {
     get { self.storage.metadata }
     set {

diff --git a/Sources/GRPCCore/Status.swift b/Sources/GRPCCore/Status.swift
@@ -25,6 +25,8 @@
 /// is similar to ``Status`` but only represents error cases, in other words represents all status
 /// codes apart from ``Code-swift.struct/ok``.
 public struct Status: @unchecked Sendable, Hashable {
+  // @unchecked because it relies on heap allocated storage and 'isKnownUniquelyReferenced'
+
   private var storage: Storage
   private mutating func ensureStorageIsUnique() {
     if !isKnownUniquelyReferenced(&self.storage) {