Capture lists in closures in Swift

Introduction

Capture lists help control how variables are used inside closures. They let you decide if variables are kept as copies or references.

When you want to keep a snapshot of a variable's value inside a closure.

When you want to avoid strong reference cycles between closures and objects.

When you want to control if a variable is captured as a strong or weak reference.

When you want to improve memory management by preventing retain cycles.

When you want to use a variable inside a closure but keep it from changing outside.

Syntax

Swift

let closure = { [captureList] in
    // closure body
}

The capture list is inside square brackets before the in keyword.

You can capture variables as strong, weak, or unowned references.

Examples

This captures value as a copy. Changing value after does not affect the closure.

Swift

var value = 10
let closure = { [value] in
    print("Captured value is \(value)")
}
value = 20
closure()

This uses a weak capture to avoid a strong reference cycle. After person is set to nil, the closure knows the object is gone.

Swift

class Person {
    var name = "Alice"
    lazy var printName: () -> Void = { [weak self] in
        if let strongSelf = self {
            print("Name is \(strongSelf.name)")
        } else {
            print("Person no longer exists")
        }
    }
}
var person: Person? = Person()
person?.printName()
let printClosure = person!.printName
person = nil
printClosure()

unowned capture assumes the variable will always exist when the closure runs. Use carefully to avoid crashes.

Swift

class Example {
    var count = 0
    lazy var increment = { [unowned self] in
        print("Count is \(self.count)")
    }
}

Sample Program

This program shows how a closure captures self weakly to avoid memory problems. It increments a count and prints it. After the counter is set to nil, the closure safely detects it.

Swift

class Counter {
    var count = 0
    lazy var incrementClosure: () -> Void = { [weak self] in
        guard let strongSelf = self else {
            print("Counter no longer exists")
            return
        }
        strongSelf.count += 1
        print("Count is now \(strongSelf.count)")
    }
}

var counter: Counter? = Counter()
print("Before increment: \(counter?.count.map(String.init) ?? \"nil\")")
counter?.incrementClosure()
counter?.incrementClosure()
let incrementClosure = counter!.incrementClosure
print("After increments: \(counter?.count.map(String.init) ?? \"nil\")")
counter = nil
incrementClosure()

Important Notes

Time complexity: Capturing variables does not add extra time cost to closure execution.

Space complexity: Captured variables are stored inside the closure, which uses some memory.

Common mistake: Forgetting to use [weak self] can cause memory leaks by keeping objects alive.

Use capture lists when you want to control how variables are stored inside closures, especially to avoid retain cycles.

Summary

Capture lists let you control how variables are saved inside closures.

Use [weak self] or [unowned self] to avoid memory problems.

Captured variables can be copies or references depending on your needs.

Practice

1. What is the main purpose of using a capture list in a Swift closure?

easy

A. To control how variables are stored and referenced inside the closure

B. To define the return type of the closure

C. To specify the closure's parameter types

D. To make the closure run asynchronously

Solution

1. Step 1: Understand what capture lists do

   Capture lists let you specify how variables are captured inside closures, either by strong, weak, or unowned references.

2. Step 2: Identify the main purpose

   The main purpose is to control how variables are stored and referenced to avoid memory leaks or unexpected behavior.

3. Final Answer:

   To control how variables are stored and referenced inside the closure -> Option A

4. Quick Check:

   Capture list purpose = control variable capture [OK]

Hint: Capture lists manage variable references inside closures [OK]

Common Mistakes:

• Confusing capture lists with closure parameters
• Thinking capture lists define return types
• Assuming capture lists affect closure execution timing

2. Which of the following is the correct syntax to declare a capture list with a weak reference to self in a Swift closure?

easy

A. let closure = { [self weak] in print(self) }

B. let closure = { weak self in print(self) }

C. let closure = { [weak self] in print(self) }

D. let closure = { (weak self) in print(self) }

Solution

1. Step 1: Recall capture list syntax

   Capture lists are declared inside square brackets before the closure parameters, e.g., [weak self].

2. Step 2: Match correct syntax

   let closure = { [weak self] in print(self) } uses the correct syntax: [weak self] inside square brackets before the closure body.

3. Final Answer:

   let closure = { [weak self] in print(self) } -> Option C

4. Quick Check:

   Capture list syntax = [weak self] [OK]

Hint: Capture lists go inside square brackets before closure body [OK]

Common Mistakes:

• Omitting square brackets around capture list
• Placing 'weak' outside the brackets
• Using parentheses instead of brackets

3. What will be the output of the following Swift code?

class Example {
    var value = 10
    lazy var closure: () -> Void = { [unowned self] in
        print(self.value)
    }
}
let example = Example()
example.value = 20
example.closure()

medium

A. 20

B. 10

C. Runtime error

D. nil

Solution

1. Step 1: Understand unowned self capture

   The closure captures self as unowned, meaning it references the original object without increasing retain count.

2. Step 2: Check value at closure call

   example.value is updated to 20 before calling closure, so print(self.value) outputs 20.

3. Final Answer:

   20 -> Option A

4. Quick Check:

   Unowned self captures current value = 20 [OK]

Hint: Unowned self captures current object state, not copy [OK]

Common Mistakes:

• Thinking closure captures old value copy
• Confusing unowned with weak causing nil
• Expecting runtime error without object deallocation

4. Identify the error in this Swift closure using a capture list:

class Test {
    var count = 0
    lazy var closure: () -> Void = { [weak self] in
        self.count += 1
        print(self.count)
    }
}

medium

A. No error, code is correct

B. Capture list syntax is incorrect

C. Closure cannot be lazy with capture list

D. Cannot use weak self without unwrapping optional

Solution

1. Step 1: Analyze weak self usage

   When capturing self as weak, self becomes an optional inside the closure.

2. Step 2: Check code for optional unwrapping

   The code uses self.count directly without unwrapping, causing a compile error.

3. Final Answer:

   Cannot use weak self without unwrapping optional -> Option D

4. Quick Check:

   Weak self requires optional unwrapping [OK]

Hint: Weak self is optional; unwrap before use [OK]

Common Mistakes:

• Using weak self as non-optional
• Ignoring optional chaining or guard let
• Assuming lazy closures can't have capture lists

5. You want to create a closure that captures a variable by making a copy of it, so changes outside the closure don't affect the closure's value. Which capture list syntax should you use in Swift?

hard

A. [weak variable]

B. [value = variable]

C. [unowned variable]

D. [copy variable]

Solution

1. Step 1: Understand capture by copy

   To capture a variable by making a copy, you assign it inside the capture list using syntax like [value = variable].

2. Step 2: Evaluate options

   [value = variable] uses the correct syntax to copy the variable's value into the closure's capture list.

3. Final Answer:

   [value = variable] -> Option B

4. Quick Check:

   Copy capture syntax = [value = variable] [OK]

Hint: Use [newName = oldVar] to capture a copy [OK]

Common Mistakes:

• Using weak or unowned which capture references
• Assuming [copy variable] is valid syntax
• Not assigning variable inside capture list