update docs to use new error types

Author: patrickfreed

Guides/Error-Handling.md

@@ -32,7 +32,7 @@ The possible errors that conform to `MongoServerError` are as follows:
 - `MongoError.BulkWriteError`
     - Thrown when the server returns errors as part of an executed bulk write.
     - If WriteConcernFailure is populated, writeErrors may not be.
-    - **Note:** `InsertMany` throws a `BulkWriteError`, _not_ a `WriteError`.
+    - **Note:** `InsertMany` throws a `MongoError.BulkWriteError`, _not_ a `MongoError.WriteError`.
 
 
 ### User Errors

Sources/MongoSwift/BSON/BSONDocument.swift

@@ -146,8 +146,8 @@ extension BSONDocument {
      *
      * - Throws:
      *   - `InternalError` if the new value is an `Int` and cannot be written to BSON.
-     *   - `LogicError` if the new value is a `BSONDecimal128` or `BSONObjectID` and is improperly formatted.
-     *   - `LogicError` if the new value is an `Array` and it contains a non-`BSONValue` element.
+     *   - `MongoError.LogicError` if the new value is a `BSONDecimal128` or `BSONObjectID` and is improperly formatted.
+     *   - `MongoError.LogicError` if the new value is an `Array` and it contains a non-`BSONValue` element.
      *   - `InternalError` if the underlying `bson_t` would exceed the maximum size by encoding this
      *     key-value pair.
      */
@@ -373,7 +373,7 @@ extension BSONDocument {
      * - Returns: the parsed `BSONDocument`
      *
      * - Throws:
-     *   - A `InvalidArgumentError` if the data passed in is invalid JSON.
+     *   - A `MongoError.InvalidArgumentError` if the data passed in is invalid JSON.
      */
     public init(fromJSON: Data) throws {
         self._storage = Storage(stealing: try fromJSON.withUnsafeBytePointer { bytes in
@@ -391,7 +391,7 @@ extension BSONDocument {
 
     /// Convenience initializer for constructing a `BSONDocument` from a `String`.
     /// - Throws:
-    ///   - A `InvalidArgumentError` if the string passed in is invalid JSON.
+    ///   - A `MongoError.InvalidArgumentError` if the string passed in is invalid JSON.
     public init(fromJSON json: String) throws {
         // `String`s are Unicode under the hood so force unwrap always succeeds.
         // see https://www.objc.io/blog/2018/02/13/string-to-data-and-back/
@@ -401,9 +401,9 @@ extension BSONDocument {
     /**
      * Constructs a `BSONDocument` from raw BSON `Data`.
      * - Throws:
-     *   - A `InvalidArgumentError` if `bson` is too short or too long to be valid BSON.
-     *   - A `InvalidArgumentError` if the first four bytes of `bson` do not contain `bson.count`.
-     *   - A `InvalidArgumentError` if the final byte of `bson` is not a null byte.
+     *   - A `MongoError.InvalidArgumentError` if `bson` is too short or too long to be valid BSON.
+     *   - A `MongoError.InvalidArgumentError` if the first four bytes of `bson` do not contain `bson.count`.
+     *   - A `MongoError.InvalidArgumentError` if the final byte of `bson` is not a null byte.
      * - SeeAlso: http://bsonspec.org/
      */
     public init(fromBSON bson: Data) throws {

Sources/MongoSwift/BSON/BSONDocumentIterator.swift

@@ -178,7 +178,7 @@ public class BSONDocumentIterator: IteratorProtocol {
      *
      * - Throws:
      *   - `InternalError` if the new value is an `Int` and cannot be written to BSON.
-     *   - `LogicError` if the new value is a `BSONDecimal128` or `BSONObjectID` and is improperly formatted.
+     *   - `MongoError.LogicError` if the new value is a `BSONDecimal128` or `BSONObjectID` and is improperly formatted.
      */
     internal func overwriteCurrentValue(with newValue: Overwritable) throws {
         let newValueType = type(of: newValue).bsonType

Sources/MongoSwift/BSON/BSONValue.swift

@@ -68,15 +68,15 @@ internal protocol BSONValue: Codable {
      * - Throws:
      *   - `InternalError` if the `DocumentStorage` would exceed the maximum size by encoding this
      *     key-value pair.
-     *   - `LogicError` if the value is an `Array` and it contains a non-`BSONValue` element.
+     *   - `MongoError.LogicError` if the value is an `Array` and it contains a non-`BSONValue` element.
      */
     func encode(to document: inout BSONDocument, forKey key: String) throws
 
     /**
      * Given a `BSONDocumentIterator` known to have a next value of this type,
      * initializes the value.
      *
-     * - Throws: `LogicError` if the current type of the `BSONDocumentIterator` does not correspond to the
+     * - Throws: `MongoError.LogicError` if the current type of the `BSONDocumentIterator` does not correspond to the
      *           associated type of this `BSONValue`.
      */
     static func from(iterator iter: BSONDocumentIterator) throws -> BSON
@@ -221,7 +221,7 @@ public struct BSONBinary: BSONValue, Equatable, Codable, Hashable {
 
     /// Initializes a `BSONBinary` instance from a `UUID`.
     /// - Throws:
-    ///   - `InvalidArgumentError` if a `BSONBinary` cannot be constructed from this UUID.
+    ///   - `MongoError.InvalidArgumentError` if a `BSONBinary` cannot be constructed from this UUID.
     public init(from uuid: UUID) throws {
         let uuidt = uuid.uuid
 
@@ -237,7 +237,7 @@ public struct BSONBinary: BSONValue, Equatable, Codable, Hashable {
 
     /// Initializes a `BSONBinary` instance from a `Data` object and a `UInt8` subtype.
     /// - Throws:
-    ///   - `InvalidArgumentError` if the provided data is incompatible with the specified subtype.
+    ///   - `MongoError.InvalidArgumentError` if the provided data is incompatible with the specified subtype.
     public init(data: Data, subtype: UInt8) throws {
         if [Subtype.uuid.rawValue, Subtype.uuidDeprecated.rawValue].contains(subtype) && data.count != 16 {
             throw MongoError.InvalidArgumentError(
@@ -251,14 +251,14 @@ public struct BSONBinary: BSONValue, Equatable, Codable, Hashable {
 
     /// Initializes a `BSONBinary` instance from a `Data` object and a `Subtype`.
     /// - Throws:
-    ///   - `InvalidArgumentError` if the provided data is incompatible with the specified subtype.
+    ///   - `MongoError.InvalidArgumentError` if the provided data is incompatible with the specified subtype.
     public init(data: Data, subtype: Subtype) throws {
         try self.init(data: data, subtype: subtype.rawValue)
     }
 
     /// Initializes a `BSONBinary` instance from a base64 `String` and a `UInt8` subtype.
     /// - Throws:
-    ///   - `InvalidArgumentError` if the base64 `String` is invalid or if the provided data is
+    ///   - `MongoError.InvalidArgumentError` if the base64 `String` is invalid or if the provided data is
     ///     incompatible with the specified subtype.
     public init(base64: String, subtype: UInt8) throws {
         guard let dataObj = Data(base64Encoded: base64) else {
@@ -272,7 +272,7 @@ public struct BSONBinary: BSONValue, Equatable, Codable, Hashable {
 
     /// Initializes a `BSONBinary` instance from a base64 `String` and a `Subtype`.
     /// - Throws:
-    ///   - `InvalidArgumentError` if the base64 `String` is invalid or if the provided data is
+    ///   - `MongoError.InvalidArgumentError` if the base64 `String` is invalid or if the provided data is
     ///     incompatible with the specified subtype.
     public init(base64: String, subtype: Subtype) throws {
         try self.init(base64: base64, subtype: subtype.rawValue)
@@ -324,7 +324,7 @@ public struct BSONBinary: BSONValue, Equatable, Codable, Hashable {
 
     /// Converts this `BSONBinary` instance to a `UUID`.
     /// - Throws:
-    ///   - `InvalidArgumentError` if a non-UUID subtype is set on this `BSONBinary`.
+    ///   - `MongoError.InvalidArgumentError` if a non-UUID subtype is set on this `BSONBinary`.
     public func toUUID() throws -> UUID {
         guard [Subtype.uuid.rawValue, Subtype.uuidDeprecated.rawValue].contains(self.subtype) else {
             throw MongoError.InvalidArgumentError(
@@ -520,7 +520,7 @@ public struct BSONDecimal128: BSONValue, Equatable, Codable, CustomStringConvert
     /// Returns the provided string as a `bson_decimal128_t`, or throws an error if initialization fails due an
     /// invalid string.
     /// - Throws:
-    ///   - `InvalidArgumentError` if the parameter string does not correspond to a valid `BSONDecimal128`.
+    ///   - `MongoError.InvalidArgumentError` if the parameter string does not correspond to a valid `BSONDecimal128`.
     internal static func toLibBSONType(_ str: String) throws -> bson_decimal128_t {
         var value = bson_decimal128_t()
         guard bson_decimal128_from_string(str, &value) else {

Sources/MongoSwift/BSON/Overwritable.swift

@@ -8,7 +8,7 @@ internal protocol Overwritable: BSONValue {
      *
      * - Throws:
      *   - `InternalError` if the `BSONValue` is an `Int` and cannot be written to BSON.
-     *   - `LogicError` if the `BSONValue` is a `Decimal128` or `BSONObjectID` and is improperly formatted.
+     *   - `MongoError.LogicError` if the `BSONValue` is a `Decimal128` or `BSONObjectID` and is improperly formatted.
      */
     func writeToCurrentPosition(of iter: BSONDocumentIterator) throws
 }

Sources/MongoSwift/ChangeStream.swift

@@ -152,9 +152,10 @@ public class ChangeStream<T: Codable>: CursorProtocol {
      *   met, potentially after multiple requests to the server.
      *
      *   If the future evaluates to an error, it is likely one of the following:
-     *     - `CommandError` if an error occurs while fetching more results from the server.
-     *     - `LogicError` if this function is called after the change stream has died.
-     *     - `LogicError` if this function is called and the session associated with this change stream is inactive.
+     *     - `MongoError.CommandError` if an error occurs while fetching more results from the server.
+     *     - `MongoError.LogicError` if this function is called after the change stream has died.
+     *     - `MongoError.LogicError` if this function is called and the session associated with this change stream is
+     *       inactive.
      *     - `DecodingError` if an error occurs decoding the server's response.
      */
     public func next() -> EventLoopFuture<T?> {
@@ -179,9 +180,10 @@ public class ChangeStream<T: Codable>: CursorProtocol {
      *    there was no data.
      *
      *    If the future evaluates to an error, it is likely one of the following:
-     *      - `CommandError` if an error occurs while fetching more results from the server.
-     *      - `LogicError` if this function is called after the change stream has died.
-     *      - `LogicError` if this function is called and the session associated with this change stream is inactive.
+     *      - `MongoError.CommandError` if an error occurs while fetching more results from the server.
+     *      - `MongoError.LogicError` if this function is called after the change stream has died.
+     *      - `MongoError.LogicError` if this function is called and the session associated with this change stream is
+     *        inactive.
      *      - `DecodingError` if an error occurs decoding the server's response.
      */
     public func tryNext() -> EventLoopFuture<T?> {
@@ -203,9 +205,10 @@ public class ChangeStream<T: Codable>: CursorProtocol {
      *    An `EventLoopFuture<[T]>` evaluating to the results currently available in this change stream, or an error.
      *
      *    If the future evaluates to an error, that error is likely one of the following:
-     *      - `CommandError` if an error occurs while fetching more results from the server.
-     *      - `LogicError` if this function is called after the change stream has died.
-     *      - `LogicError` if this function is called and the session associated with this change stream is inactive.
+     *      - `MongoError.CommandError` if an error occurs while fetching more results from the server.
+     *      - `MongoError.LogicError` if this function is called after the change stream has died.
+     *      - `MongoError.LogicError` if this function is called and the session associated with this change stream is
+     *        inactive.
      *      - `DecodingError` if an error occurs decoding the server's responses.
      */
     public func toArray() -> EventLoopFuture<[T]> {
@@ -230,9 +233,10 @@ public class ChangeStream<T: Codable>: CursorProtocol {
      *     encountered.
      *
      *     If the future evaluates to an error, that error is likely one of the following:
-     *     - `CommandError` if an error occurs while fetching more results from the server.
-     *     - `LogicError` if this function is called after the change stream has died.
-     *     - `LogicError` if this function is called and the session associated with this change stream is inactive.
+     *     - `MongoError.CommandError` if an error occurs while fetching more results from the server.
+     *     - `MongoError.LogicError` if this function is called after the change stream has died.
+     *      - `MongoError.LogicError` if this function is called and the session associated with this change stream is
+     *        inactive.
      *     - `DecodingError` if an error occurs decoding the server's responses.
      */
     public func forEach(_ body: @escaping (T) throws -> Void) -> EventLoopFuture<Void> {

Sources/MongoSwift/ClientSession.swift

@@ -325,7 +325,7 @@ public final class ClientSession {
 
     /// Appends this provided session to an options document for libmongoc interoperability.
     /// - Throws:
-    ///   - `LogicError` if this session is inactive
+    ///   - `MongoError.LogicError` if this session is inactive
     internal func append(to doc: inout BSONDocument) throws {
         guard case let .started(session, _) = self.state else {
             throw ClientSession.SessionInactiveError
@@ -360,9 +360,9 @@ public final class ClientSession {
      *    An `EventLoopFuture<Void>` that succeeds when `startTransaction` is successful.
      *
      *    If the future fails, the error is likely one of the following:
-     *    - `CommandError` if an error occurs that prevents the command from executing.
-     *    - `LogicError` if the session already has an in-progress transaction.
-     *    - `LogicError` if `startTransaction` is called on an ended session.
+     *    - `MongoError.CommandError` if an error occurs that prevents the command from executing.
+     *    - `MongoError.LogicError` if the session already has an in-progress transaction.
+     *    - `MongoError.LogicError` if `startTransaction` is called on an ended session.
      *
      * - SeeAlso:
      *   - https://docs.mongodb.com/manual/core/transactions/
@@ -384,9 +384,9 @@ public final class ClientSession {
      *    An `EventLoopFuture<Void>` that succeeds when `commitTransaction` is successful.
      *
      *    If the future fails, the error is likely one of the following:
-     *    - `CommandError` if an error occurs that prevents the command from executing.
-     *    - `LogicError` if the session has no in-progress transaction.
-     *    - `LogicError` if `commitTransaction` is called on an ended session.
+     *    - `MongoError.CommandError` if an error occurs that prevents the command from executing.
+     *    - `MongoError.LogicError` if the session has no in-progress transaction.
+     *    - `MongoError.LogicError` if `commitTransaction` is called on an ended session.
      *
      * - SeeAlso:
      *   - https://docs.mongodb.com/manual/core/transactions/
@@ -408,8 +408,8 @@ public final class ClientSession {
      *    An `EventLoopFuture<Void>` that succeeds when `abortTransaction` is successful.
      *
      *    If the future fails, the error is likely one of the following:
-     *    - `LogicError` if the session has no in-progress transaction.
-     *    - `LogicError` if `abortTransaction` is called on an ended session.
+     *    - `MongoError.LogicError` if the session has no in-progress transaction.
+     *    - `MongoError.LogicError` if `abortTransaction` is called on an ended session.
      *
      * - SeeAlso:
      *   - https://docs.mongodb.com/manual/core/transactions/