Custom result builder declaration in Swift - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is a custom result builder in Swift?

A custom result builder is a special type that lets you create a DSL (Domain Specific Language) by combining multiple statements into a single result, using a clean and readable syntax.

beginner

Which attribute do you use to declare a custom result builder in Swift?

You use the @resultBuilder attribute before a struct or enum to declare it as a custom result builder.

intermediate

Name two required static methods a custom result builder must implement.

The two required static methods are buildBlock(_ components: Component...) and buildExpression(_ expression: Expression). These combine parts of the DSL into a final result.

beginner

What does the buildBlock method do in a custom result builder?

It combines multiple components into one result. Think of it like putting puzzle pieces together to form the final picture.

intermediate

How can you handle optional statements inside a custom result builder?

You implement the buildOptional(_ component: Component?) method to handle optional parts, like if statements that might or might not add content.

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

A @dslBuilder

B @builder

C @customBuilder

D @resultBuilder

The correct attribute is @resultBuilder to declare a custom result builder.

Which method combines multiple components into one in a custom result builder?

A buildBlock

B buildFinal

C buildOptional

D buildExpression

buildBlock combines multiple components into a single result.

How do you handle optional content inside a custom result builder?

A buildExpression

B buildOptional

C buildIf

D buildBlock

The buildOptional method handles optional components like if statements.

What is the main purpose of a custom result builder?

A To simplify combining multiple statements into one result

B To create a new data type

C To improve performance

D To handle errors automatically

Custom result builders simplify combining multiple statements into a single, readable result.

Which of these is NOT a typical method in a custom result builder?

A buildOptional

B buildExpression

C buildClass

D buildBlock

buildClass is not a method used in custom result builders.

Explain how to declare and use a custom result builder in Swift.

Think about how you create a mini language inside Swift using special methods.

Describe how optional and conditional statements are handled inside a custom result builder.

Consider how if statements might add or skip parts in the final result.

Practice

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

easy

A. To handle errors automatically in functions

B. To create a new data type like a class or struct

C. To optimize memory usage during runtime

D. To define how multiple code parts combine into a single result

Solution

1. Step 1: Understand the role of @resultBuilder

   A @resultBuilder is used to customize how multiple code blocks combine into one result, making code cleaner.

2. Step 2: Compare with other options

   Options A, B, and D describe unrelated concepts like error handling, data types, and optimization, which are not the purpose of result builders.

3. Final Answer:

   To define how multiple code parts combine into a single result -> Option D

4. Quick Check:

   Result builder = combine code parts [OK]

Hint: Result builders combine code parts into one result [OK]

Common Mistakes:

• Confusing result builders with classes or structs
• Thinking result builders handle errors
• Assuming result builders optimize memory

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

easy

A. @resultBuilder struct MyBuilder { static func buildBlock() -> String { "" } }

B. @resultBuilder class MyBuilder { func buildBlock() {} }

C. class MyBuilder { func buildBlock() -> Int { 0 } }

D. struct MyBuilder { static func buildBlock() {} }

Solution

1. Step 1: Identify correct syntax for result builder

   A custom result builder must be declared with @resultBuilder attribute on a struct, and have static methods like buildBlock returning a value.

2. Step 2: Check each option

   @resultBuilder struct MyBuilder { static func buildBlock() -> String { "" } } correctly uses @resultBuilder, declares a struct, and has a static buildBlock method returning a String. The other options miss the attribute, use class instead of struct, or have non-static buildBlock.

3. Final Answer:

   @resultBuilder struct MyBuilder { static func buildBlock() -> String { "" } } -> Option A

4. Quick Check:

   Result builder = @resultBuilder + struct + static methods [OK]

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

Common Mistakes:

• Using class instead of struct for result builder
• Forgetting the @resultBuilder attribute
• Making buildBlock non-static

3. Given this custom result builder and usage, what is the output?

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

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

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

medium

A. 5103

B. 18

C. Error: buildBlock requires array

D. 0

Solution

1. Step 1: Understand buildBlock behavior

   The buildBlock method takes multiple Int values and sums them using reduce(0, +).

2. Step 2: Evaluate the sum call

   The closure passed to sum returns three Int values: 5, 10, and 3. The builder sums them: 5 + 10 + 3 = 18.

3. Final Answer:

   18 -> Option B

4. Quick Check:

   Sum of 5, 10, 3 = 18 [OK]

Hint: buildBlock sums all Int inputs passed in closure [OK]

Common Mistakes:

• Thinking values concatenate as strings
• Expecting buildBlock to receive an array instead of variadic
• Confusing output with zero or error

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

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

medium

A. buildBlock must be static

B. buildBlock must return Int

C. struct cannot be used with @resultBuilder

D. buildBlock cannot take variadic parameters

Solution

1. Step 1: Check method requirements in result builder

   Methods like buildBlock inside a @resultBuilder must be declared as static so they can be called without an instance.

2. Step 2: Analyze the given code

   The buildBlock method is missing the static keyword, which causes a compile error.

3. Final Answer:

   buildBlock must be static -> Option A

4. Quick Check:

   buildBlock method = static [OK]

Hint: buildBlock must always be static in result builders [OK]

Common Mistakes:

• Omitting static keyword on buildBlock
• Thinking buildBlock must return Int always
• Believing struct can't be used with @resultBuilder

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 buildBlock implementations correctly combines multiple (String, Int) tuples into a single dictionary?

hard

A. static func buildBlock(_ pairs: (String, Int)...) -> [String: Int] { pairs.map { [$0.0: $0.1] } }

B. static func buildBlock(_ pairs: [(String, Int)]) -> [String: Int] { pairs.reduce([:]) { $0 + $1 } }

C. static func buildBlock(_ pairs: (String, Int)...) -> [String: Int] { Dictionary(uniqueKeysWithValues: pairs) }

D. static func buildBlock(_ pairs: (String, Int)...) -> [(String, Int)] { pairs }

Solution

1. Step 1: Understand the goal

   The builder should combine multiple key-value pairs into a single dictionary.

2. Step 2: Analyze each option

   static func buildBlock(_ pairs: (String, Int)...) -> [String: Int] { Dictionary(uniqueKeysWithValues: pairs) } uses Dictionary(uniqueKeysWithValues:) which correctly creates a dictionary from tuples. static func buildBlock(_ pairs: [(String, Int)]) -> [String: Int] { pairs.reduce([:]) { $0 + $1 } } tries to reduce with + which is invalid for dictionaries. static func buildBlock(_ pairs: (String, Int)...) -> [String: Int] { pairs.map { [$0.0: $0.1] } } maps to an array of dictionaries, not a single dictionary. static func buildBlock(_ pairs: (String, Int)...) -> [(String, Int)] { pairs } returns an array of tuples, not a dictionary.

3. Final Answer:

   static func buildBlock(_ pairs: (String, Int)...) -> [String: Int] { Dictionary(uniqueKeysWithValues: pairs) } -> Option C

4. Quick Check:

   Use Dictionary(uniqueKeysWithValues:) to combine tuples [OK]

Hint: Use Dictionary(uniqueKeysWithValues:) to build dictionary from tuples [OK]

Common Mistakes:

• Returning array of dictionaries instead of one dictionary
• Using invalid + operator to combine dictionaries
• Returning array of tuples instead of dictionary