Uploaded image for project: 'Swift Driver'
  1. Swift Driver
  2. SWIFT-192

Make Document conform to Collection protocol

    XMLWordPrintable

Details

    • Improvement
    • Status: Closed
    • Minor - P4
    • Resolution: Fixed
    • None
    • 0.0.8
    • None

    Description

      The Collection protocol inherits from the Sequence protocol, which Document conforms to as of SWIFT-195.

      Conforming to Collection will require adding startIndex and endIndex properties (firstKey and lastKey), as well as an index(after: ) (basically nextKey) method. We should likely just convert SWIFT-195's Document+Sequence extension to be Document+Collection and have it all live there. Given the new understandings of what we will need to do too get true conformance to a Collection (w.r.t. runtime complexities), combining the two will probably lead to a big file, so splitting it may just be more manageable and organized.

      The documentation notes that "Types that conform to Collection are expected to provide the startIndex and endIndex properties and subscript access to elements as O(1) operations. Types that are not able to guarantee this performance must document the departure, because many collection operations depend on O(1) subscripting performance for their own performance guarantees."

      We could potentially provide the startIndex and endIndex properties in O(1) if we wanted to store them in the Document. We would be unable to do that for subscript access, but it seems like it's ok to just document that departure.

       

      Attachments

        Issue Links

          Activity

            People

              may.hoque@mongodb.com May Hoque
              kaitlin.mahar@mongodb.com Kaitlin Mahar
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: