EnumerationSwift5.9.0

    Optional

    A type that represents either a wrapped value or the absence of a value.

    @frozen enum Optional<Wrapped>

    You use the Optional type whenever you use optional values, even if you never type the word Optional. Swift’s type system usually shows the wrapped type’s name with a trailing question mark (?) instead of showing the full type name. For example, if a variable has the type Int?, that’s just another way of writing Optional<Int>. The shortened form is preferred for ease of reading and writing code.

    The types of shortForm and longForm in the following code sample are the same:

    let shortForm: Int? = Int("42")
    let longForm: Optional<Int> = Int("42")

    The Optional type is an enumeration with two cases. Optional.none is equivalent to the nil literal. Optional.some(Wrapped) stores a wrapped value. For example:

    let number: Int? = Optional.some(42)
    let noNumber: Int? = Optional.none
    print(noNumber == nil)
    // Prints "true"

    You must unwrap the value of an Optional instance before you can use it in many contexts. Because Swift provides several ways to safely unwrap optional values, you can choose the one that helps you write clear, concise code.

    The following examples use this dictionary of image names and file paths:

    let imagePaths = ["star": "/glyphs/star.png",
                      "portrait": "/images/content/portrait.jpg",
                      "spacer": "/images/shared/spacer.gif"]

    Getting a dictionary’s value using a key returns an optional value, so imagePaths["star"] has type Optional<String> or, written in the preferred manner, String?.

    Optional Binding

    To conditionally bind the wrapped value of an Optional instance to a new variable, use one of the optional binding control structures, including if let, guard let, and switch.

    if let starPath = imagePaths["star"] {
        print("The star image is at '\(starPath)'")
    } else {
        print("Couldn't find the star image")
    }
    // Prints "The star image is at '/glyphs/star.png'"

    Optional Chaining

    To safely access the properties and methods of a wrapped instance, use the postfix optional chaining operator (postfix ?). The following example uses optional chaining to access the hasSuffix(_:) method on a String? instance.

    if imagePaths["star"]?.hasSuffix(".png") == true {
        print("The star image is in PNG format")
    }
    // Prints "The star image is in PNG format"

    Using the Nil-Coalescing Operator

    Use the nil-coalescing operator (??) to supply a default value in case the Optional instance is nil. Here a default path is supplied for an image that is missing from imagePaths.

    let defaultImagePath = "/images/default.png"
    let heartPath = imagePaths["heart"] ?? defaultImagePath
    print(heartPath)
    // Prints "/images/default.png"

    The ?? operator also works with another Optional instance on the right-hand side. As a result, you can chain multiple ?? operators together.

    let shapePath = imagePaths["cir"] ?? imagePaths["squ"] ?? defaultImagePath
    print(shapePath)
    // Prints "/images/default.png"

    Unconditional Unwrapping

    When you’re certain that an instance of Optional contains a value, you can unconditionally unwrap the value by using the forced unwrap operator (postfix !). For example, the result of the failable Int initializer is unconditionally unwrapped in the example below.

    let number = Int("42")!
    print(number)
    // Prints "42"

    You can also perform unconditional optional chaining by using the postfix ! operator.

    let isPNG = imagePaths["star"]!.hasSuffix(".png")
    print(isPNG)
    // Prints "true"

    Unconditionally unwrapping a nil instance with ! triggers a runtime error.

    Citizens in Swift

    Conformances

    Members

    Citizens in Swift

    where Wrapped:Hashable

    Conformances

    • protocol Hashable

      A type that can be hashed into a Hasher to produce an integer hash value.

    Members

    Citizens in Swift

    where Wrapped:Decodable

    Conformances

    Members

    Citizens in Swift

    where Wrapped:Equatable

    Conformances

    Members

    Features

    Citizens in Swift

    where Wrapped:Sendable

    Conformances

    • protocol Sendable

      A type whose values can safely be passed across concurrency domains by copying.

    Citizens in Swift

    where Wrapped:Encodable

    Conformances

    Members

    Available in _Differentiation

    where Wrapped:Differentiable

    Conformances

    • protocol Differentiable

      A type that mathematically represents a differentiable manifold whose tangent spaces are finite-dimensional.

    Members

    Available in Cxx

    Members

    Available in Cxx

    where Wrapped:UnsafeCxxInputIterator

    Conformances

    Members

    Available in Foundation

    where Wrapped:EncodableWithConfiguration

    Conformances

    Members

    Available in Foundation

    where Wrapped:DecodableWithConfiguration

    Conformances

    Members

    Extension in BSON

    where Wrapped:PrimitiveEncodable

    Conformances

    Members

    Extension in BSON

    where Wrapped == Primitive

    Members

    Extension in Meow

    where Wrapped:Resolvable

    Conformances

    Members

    Extension in Atomics

    where Wrapped:AtomicOptionalWrappable, Wrapped == Wrapped.AtomicRepresentation.Value

    Conformances

    • protocol AtomicValue

      A type that supports atomic operations through a separate atomic storage representation.

    Members

    Extension in Grammar

    where Wrapped:ParsingRule

    Conformances

    Members

    Features

    Extension in NIOCore

    where Wrapped == ByteBuffer

    Members

    Extension in SwiftSyntaxBuilder

    where Wrapped:ExpressibleByLiteralSyntax

    Conformances

    Members