@resultBuilder attribute in Swift - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is the purpose of the @resultBuilder attribute in Swift?

The @resultBuilder attribute helps create a special kind of function builder that lets you write clean, readable code by combining multiple statements into a single result, often used for building complex data like views or expressions.

beginner

How does a @resultBuilder transform the way you write code inside a closure?

It allows you to write multiple statements or expressions inside a closure without explicitly returning or combining them; the builder automatically collects and combines these into one final result.

intermediate

Name two required static methods that a @resultBuilder type must implement.

1. buildBlock(_ components: Component...) to combine components.
2. buildOptional(_ component: Component?) to handle optional components (like if statements).

beginner

True or False: @resultBuilder can only be used with SwiftUI views.

False. While commonly used in SwiftUI, @resultBuilder can be used to build any kind of DSL (Domain Specific Language) or complex data structure by combining multiple statements.

intermediate

What is the benefit of using @resultBuilder when creating DSLs in Swift?

It makes the code look natural and easy to read, similar to writing plain code, while under the hood it builds complex data structures or logic from simple statements.

What does the @resultBuilder attribute primarily help with in Swift?

A Improving runtime performance

B Combining multiple statements into a single result

C Automatically generating UI elements

D Handling errors in asynchronous code

The @resultBuilder attribute helps combine multiple statements or expressions into one result, making code cleaner and easier to write.

Which method is essential in a @resultBuilder to combine multiple components?

A buildBlock

B buildCombine

C buildResult

D buildMerge

The buildBlock method is required to combine multiple components into one result.

Can @resultBuilder handle conditional statements like if inside its closure?

A Yes, using buildOptional and buildEither methods

B No, it only supports simple statements

C Only if wrapped in a function

D Only with special syntax

Conditional statements are supported by implementing methods like buildOptional and buildEither in the builder.

Which of these is NOT a typical use case for @resultBuilder?

A Defining HTML-like DSLs

B Creating SQL query builders

C Building SwiftUI views

D Writing asynchronous network code

@resultBuilder is not designed specifically for asynchronous code but for building complex data from multiple statements.

What keyword do you use to mark a type as a result builder in Swift?

A @combine

B @builder

C @resultBuilder

D @dslBuilder

The correct attribute to mark a type as a result builder is @resultBuilder.

Explain how the @resultBuilder attribute changes the way you write code inside a closure. Include examples of what kinds of methods the builder type must implement.

Think about how you write SwiftUI views or other DSLs using multiple lines inside a closure.

Describe a real-life scenario where using @resultBuilder would make your Swift code easier to read and write.

Consider how SwiftUI uses it or how you might build HTML or SQL queries in Swift.

Practice

1. What is the main purpose of the @resultBuilder attribute in Swift?

easy

A. To combine multiple expressions into a single result in a clean way

B. To declare a new type of variable

C. To handle errors automatically

D. To create a new thread for concurrent execution

Solution

1. Step 1: Understand the role of @resultBuilder

   @resultBuilder is used to combine multiple code lines or expressions into one result, making code cleaner and easier to write.

2. Step 2: Compare options with the purpose

   Options B, C, and D describe unrelated features. Only To combine multiple expressions into a single result in a clean way correctly describes the purpose of @resultBuilder.

3. Final Answer:

   To combine multiple expressions into a single result in a clean way -> Option A

4. Quick Check:

   @resultBuilder purpose = combine expressions [OK]

Hint: Remember: @resultBuilder combines code lines into one result [OK]

Common Mistakes:

• Confusing @resultBuilder with error handling
• Thinking it creates new variables
• Assuming it manages concurrency

2. Which of the following is the correct way to declare a custom result builder in Swift?

easy

A. @resultBuilder class MyBuilder { func buildBlock(_ components: Int...) -> Int { components.reduce(0, +) } }

B. @resultBuilder struct MyBuilder { static func buildBlock(_ components: Int...) -> Int { components.reduce(0, +) } }

C. @resultBuilder func MyBuilder(_ components: Int...) -> Int { components.reduce(0, +) }

D. struct MyBuilder { func buildBlock(_ components: Int...) -> Int { components.reduce(0, +) } }

Solution

1. Step 1: Identify correct @resultBuilder declaration

   A custom result builder must be declared as a struct or enum with the @resultBuilder attribute and static buildBlock method.

2. Step 2: Check each option

   @resultBuilder struct MyBuilder { static func buildBlock(_ components: Int...) -> Int { components.reduce(0, +) } } correctly uses @resultBuilder on a struct and static buildBlock method. struct MyBuilder { func buildBlock(_ components: Int...) -> Int { components.reduce(0, +) } } misses @resultBuilder and static keyword. @resultBuilder func MyBuilder(_ components: Int...) -> Int { components.reduce(0, +) } wrongly applies @resultBuilder to a function. @resultBuilder class MyBuilder { func buildBlock(_ components: Int...) -> Int { components.reduce(0, +) } } uses a class, which is not allowed.

3. Final Answer:

   @resultBuilder struct MyBuilder { static func buildBlock(_ components: Int...) -> Int { components.reduce(0, +) } } -> Option B

4. Quick Check:

   Custom builder = struct + @resultBuilder + static buildBlock [OK]

Hint: Use @resultBuilder on struct with static buildBlock method [OK]

Common Mistakes:

• Forgetting static keyword on buildBlock
• Applying @resultBuilder to functions
• Using class instead of struct or enum

3. Given the following code, what will be printed?

 @resultBuilder struct SumBuilder {
    static func buildBlock(_ components: Int...) -> Int {
        components.reduce(0, +)
    }
}

func sum(@SumBuilder _ content: () -> Int) -> Int {
    content()
}

let result = sum {
    2
    3
    5
}
print(result)

medium

A. Error: Missing return

B. 235

C. 0

D. 10

Solution

1. Step 1: Understand buildBlock behavior

   The buildBlock method receives all integers (2, 3, 5) and sums them using reduce(0, +), resulting in 10.

2. Step 2: Check function call and output

   The sum function calls content(), which triggers the builder and returns 10. print(result) outputs 10.

3. Final Answer:

   10 -> Option D

4. Quick Check:

   Sum of 2+3+5 = 10 [OK]

Hint: Sum builder adds all values inside closure [OK]

Common Mistakes:

• Thinking values concatenate as strings
• Expecting a syntax error
• Missing that buildBlock returns sum

4. Identify the error in this custom result builder code:

 @resultBuilder struct MyBuilder {
    func buildBlock(_ components: String...) -> String {
        components.joined(separator: ", ")
    }
}

func buildString(@MyBuilder _ content: () -> String) -> String {
    content()
}

let result = buildString {
    "Hello"
    "World"
}
print(result)

medium

A. Missing return statement in buildBlock

B. Cannot use String type in result builder

C. buildBlock must be static

D. Function buildString should not have @MyBuilder

Solution

1. Step 1: Check buildBlock method declaration

   In a result builder, buildBlock must be a static method. Here it is an instance method (missing static).

2. Step 2: Verify other parts

   Return statement is present, String type is allowed, and function parameter correctly uses @MyBuilder.

3. Final Answer:

   buildBlock must be static -> Option C

4. Quick Check:

   buildBlock static keyword required [OK]

Hint: Always make buildBlock static in result builders [OK]

Common Mistakes:

• Omitting static keyword on buildBlock
• Confusing return statement presence
• Thinking @resultBuilder restricts types

5. You want to create a custom result builder that builds a dictionary from key-value pairs written inside a closure. Which of the following implementations correctly uses @resultBuilder to achieve this?

hard

A. @resultBuilder
struct DictBuilder {
static func buildBlock(_ components: (String, Int)...) -> [String: Int] {
var dict = [String: Int]()
for (key, value) in components {
dict[key] = value
}
return dict
}
}

func buildDict(@DictBuilder _ content: () -> [String: Int]) -> [String: Int] {
content()
}

let dict = buildDict {
("a", 1)
("b", 2)
("c", 3)
}
print(dict)

B. @resultBuilder
struct DictBuilder {
static func buildBlock(_ components: [String: Int]...) -> [String: Int] {
components.reduce([:]) { $0.merging($1) { $1 } }
}
}

func buildDict(@DictBuilder _ content: () -> [String: Int]) -> [String: Int] {
content()
}

let dict = buildDict {
["a": 1]
["b": 2]
["c": 3]
}
print(dict)

C. @resultBuilder
struct DictBuilder {
static func buildBlock(_ components: String...) -> [String: Int] {
[:]
}
}

func buildDict(@DictBuilder _ content: () -> [String: Int]) -> [String: Int] {
content()
}

let dict = buildDict {
"a:1"
"b:2"
"c:3"
}
print(dict)

D. struct DictBuilder {
static func buildBlock(_ components: (String, Int)...) -> [String: Int] {
var dict = [String: Int]()
for (key, value) in components {
dict[key] = value
}
return dict
}
}

func buildDict(@DictBuilder _ content: () -> [String: Int]) -> [String: Int] {
content()
}

let dict = buildDict {
("a", 1)
("b", 2)
("c", 3)
}
print(dict)

Solution

1. Step 1: Check for @resultBuilder attribute and static buildBlock

   @resultBuilder struct DictBuilder { static func buildBlock(_ components: (String, Int)...) -> [String: Int] { var dict = [String: Int]() for (key, value) in components { dict[key] = value } return dict } } func buildDict(@DictBuilder _ content: () -> [String: Int]) -> [String: Int] { content() } let dict = buildDict { ("a", 1) ("b", 2) ("c", 3) } print(dict) correctly declares @resultBuilder on a struct and has a static buildBlock method that combines tuples into a dictionary.

2. Step 2: Verify code correctness and usage

   @resultBuilder struct DictBuilder { static func buildBlock(_ components: [String: Int]...) -> [String: Int] { components.reduce([:]) { $0.merging($1) { $1 } } } } func buildDict(@DictBuilder _ content: () -> [String: Int]) -> [String: Int] { content() } let dict = buildDict { ["a": 1] ["b": 2] ["c": 3] } print(dict) uses arrays of dictionaries which works but is less direct than tuples; @resultBuilder struct DictBuilder { static func buildBlock(_ components: String...) -> [String: Int] { [:] } } func buildDict(@DictBuilder _ content: () -> [String: Int]) -> [String: Int] { content() } let dict = buildDict { "a:1" "b:2" "c:3" } print(dict) returns empty dictionary ignoring input; struct DictBuilder { static func buildBlock(_ components: (String, Int)...) -> [String: Int] { var dict = [String: Int]() for (key, value) in components { dict[key] = value } return dict } } func buildDict(@DictBuilder _ content: () -> [String: Int]) -> [String: Int] { content() } let dict = buildDict { ("a", 1) ("b", 2) ("c", 3) } print(dict) misses @resultBuilder attribute, so it won't work as a builder.

3. Final Answer:

   Option A correctly implements a dictionary builder using @resultBuilder -> Option A

4. Quick Check:

   @resultBuilder + static buildBlock + tuple input = correct dictionary builder [OK]

Hint: Use tuples and static buildBlock with @resultBuilder for dictionary [OK]

Common Mistakes:

• Forgetting @resultBuilder attribute
• Returning empty or wrong type
• Using non-static buildBlock