How flatMap API contract transforms Optional input to Non Optional result?

by

As you’re using the identity transform { $0 }, the compiler will infer that ElementOfResult? (the result of the transform) is equivalent to Element (the argument of the transform). In this case, Element is String?, therefore ElementOfResult? == String?. There’s no need for optional promotion here, so ElementOfResult can be inferred to be String.

Therefore flatMap(_:) in this case returns a [String].

Internally, this conversion from the closure’s return of ElementOfResult? to ElementOfResult is simply done by conditionally unwrapping the optional, and if successful, the unwrapped value is appended to the result. You can see the exact implementation here.

As an addendum, note that as Martin points out, closure bodies only participate in type inference when they’re single-statement closures (see this related bug report). The reasoning for this was given by Jordan Rose in this mailing list discussion:

Swift’s type inference is currently statement-oriented, so there’s no easy way to do [multiple-statement closure] inference. This is at least partly a compilation-time concern: Swift’s type system allows many more possible conversions than, say, Haskell or OCaml, so solving the types for an entire multi-statement function is not a trivial problem, possibly not a tractable problem.

This means that for closures with multiple statements that are passed to methods such as map(_:) or flatMap(_:) (where the result type is a generic placeholder), you’ll have to explicitly annotate the return type of the closure, or the method return itself.

For example, this doesn’t compile:

// error: Unable to infer complex closure return type; add explicit type to disambiguate.
let result = albums.flatMap {
    print($0 as Any)
    return $0
}

But these do:

// explicitly annotate [ElementOfResult] to be [String] – thus ElementOfResult == String.
let result: [String] = albums.flatMap {
    print($0 as Any)
    return $0
}


// explicitly annotate ElementOfResult? to be String? – thus ElementOfResult == String.
let result = albums.flatMap { element -> String? in
    print(element as Any)
    return element
}

More Related Contents:

  1. Protocol doesn’t conform to itself?
  2. Swift generic coercion misunderstanding
  3. Is it possible to add type constraints to a Swift protocol conformance extension?
  4. What does “Protocol … can only be used as a generic constraint because it has Self or associated type requirements” mean?
  5. How do I store a value of type Class in a Dictionary of type [String:Class] in Swift?
  6. What is the in-practice difference between generic and protocol-typed function parameters?
  7. Why can’t I pass a Protocol.Type to a generic T.Type parameter?
  8. How do you unwrap Swift optionals?
  9. Using a Type Variable in a Generic
  10. Extend array types using where clause in Swift
  11. unwrapping multiple optionals in if statement
  12. What happened to the UIView?() constructor in Swift 3.0?
  13. Providing a default value for an Optional in Swift?
  14. Swift generics not preserving type
  15. Generic function taking a type name in Swift
  16. Constant unassigned optional will not be nil by default
  17. Downcasting optionals in Swift: as? Type, or as! Type?
  18. How to pass one SwiftUI View as a variable to another View struct
  19. How to determine if a generic is an optional in Swift?
  20. Default value for optional generic parameter in Swift function
  21. A Swift protocol requirement that can only be satisfied by using a final class
  22. Swift optional inout parameters and nil
  23. Convert Swift Array to Dictionary with indexes [duplicate]
  24. Can I assign a default type to generic type T in Swift?
  25. Swift nil has a numeric value?
  26. How does Swift ReferenceWritableKeyPath work with an Optional property?
  27. Migrating Swift code to Swift 3.0 LOADS of errors
  28. Sheet inside ForEach doesn’t loop over items SwiftUI
  29. How do I import a Swift file from another Swift file?
  30. How to use a @FetchRequest with the new searchable modifier in SwiftUI?

Leave a Comment