SWIFT-779 Funnel all bson_t access through helper methods (#453)

Author: kmahar

Sources/MongoSwift/BSON/BSONEncoder.swift

@@ -754,8 +754,8 @@ private class MutableArray: BSONValue {
 
     /// methods required by the BSONValue protocol that we don't actually need/use. MutableArray
     /// is just a BSONValue to simplify usage alongside true BSONValues within the encoder.
-    fileprivate func encode(to _: DocumentStorage, forKey _: String) throws {
-        fatalError("`MutableArray` is not meant to be encoded to a `DocumentStorage`")
+    fileprivate func encode(to _: inout Document, forKey _: String) throws {
+        fatalError("`MutableArray` is not meant to be encoded to a `Document`")
     }
 
     internal static func from(iterator _: DocumentIterator) -> BSON {
@@ -818,8 +818,8 @@ private class MutableDictionary: BSONValue {
 
     /// methods required by the BSONValue protocol that we don't actually need/use. MutableDictionary
     /// is just a BSONValue to simplify usage alongside true BSONValues within the encoder.
-    fileprivate func encode(to _: DocumentStorage, forKey _: String) throws {
-        fatalError("`MutableDictionary` is not meant to be encoded to a `DocumentStorage`")
+    fileprivate func encode(to _: inout Document, forKey _: String) throws {
+        fatalError("`MutableDictionary` is not meant to be encoded to a `Document`")
     }
 
     internal static func from(iterator _: DocumentIterator) -> BSON {

Sources/MongoSwift/BSON/BSONValue.swift

@@ -38,7 +38,7 @@ extension Document: Collection {
         // criticism also applies to key-based subscripting via `String`.
         // See SWIFT-250.
         self.failIndexCheck(position)
-        guard let iter = DocumentIterator(forDocument: self) else {
+        guard let iter = DocumentIterator(over: self) else {
             fatalError("Failed to initialize an iterator over document \(self)")
         }
 

Sources/MongoSwift/BSON/Document+Collection.swift

@@ -23,7 +23,7 @@ extension Document: Sequence {
 
     /// Returns a `DocumentIterator` over the values in this `Document`.
     public func makeIterator() -> DocumentIterator {
-        guard let iter = DocumentIterator(forDocument: self) else {
+        guard let iter = DocumentIterator(over: self) else {
             fatalError("Failed to initialize an iterator over document \(self)")
         }
         return iter