Property wrappers with configuration in Swift

Introduction

Property wrappers let you add extra behavior to variables easily. Configuring them means you can customize how they work for each use.

When you want to add validation to a variable but with different rules each time.

When you want to store a value with default behavior but sometimes change that behavior.

When you want to log changes to a variable but only for some variables.

When you want to limit a number to a range but the range changes per variable.

Syntax

Swift

@propertyWrapper
struct WrapperName {
    var wrappedValue: Type
    init(wrappedValue: Type, configParam: ConfigType) {
        // use configParam to customize behavior
        self.wrappedValue = wrappedValue
    }
}

The init(wrappedValue:configParam:) lets you pass extra settings when you use the wrapper.

You use the wrapper by adding @WrapperName(configParam: value) before a variable.

Examples

This clamps the score between 0 and 10 using the Clamped wrapper with configuration.

Swift

@Clamped(min: 0, max: 10) var score: Int = 5

This defines a Clamped wrapper that keeps a number inside a range given by min and max.

Swift

import Foundation

@propertyWrapper
struct Clamped {
    private var value: Int
    let min: Int
    let max: Int

    var wrappedValue: Int {
        get { value }
        set { value = Swift.min(Swift.max(newValue, min), max) }
    }

    init(wrappedValue: Int, min: Int, max: Int) {
        self.min = min
        self.max = max
        self.value = Swift.min(Swift.max(wrappedValue, min), max)
    }
}

Sample Program

This program uses a Clamped property wrapper with configuration to keep health and level inside set ranges. When we try to set values outside the range, they get clamped back inside.

Swift

import Foundation

@propertyWrapper
struct Clamped {
    private var value: Int
    let min: Int
    let max: Int

    var wrappedValue: Int {
        get { value }
        set { value = Swift.min(Swift.max(newValue, min), max) }
    }

    init(wrappedValue: Int, min: Int, max: Int) {
        self.min = min
        self.max = max
        self.value = Swift.min(Swift.max(wrappedValue, min), max)
    }
}

struct Player {
    @Clamped(min: 0, max: 100) var health: Int = 50
    @Clamped(min: 1, max: 10) var level: Int = 1
}

var player = Player()
print("Initial health: \(player.health)")
print("Initial level: \(player.level)")

player.health = 150
player.level = 0
print("After setting health to 150: \(player.health)")
print("After setting level to 0: \(player.level)")

Important Notes

Property wrappers with configuration let you reuse code but customize it for each variable.

Use descriptive names for configuration parameters to make your code easy to read.

Remember to handle the initial value inside the wrapper's initializer to apply the configuration right away.

Summary

Property wrappers add extra behavior to variables.

Configuration parameters let you customize that behavior per use.

This helps keep your code clean and reusable.

Practice

1. What is the main purpose of using property wrappers with configuration in Swift?

easy

A. To automatically generate UI elements

B. To create new data types from scratch

C. To replace functions with variables

D. To add reusable behavior to properties with customizable settings

Solution

1. Step 1: Understand property wrappers

   Property wrappers add extra behavior to properties, like validation or formatting.

2. Step 2: Understand configuration

   Configuration lets you customize how the wrapper behaves for each property.

3. Final Answer:

   To add reusable behavior to properties with customizable settings -> Option D

4. Quick Check:

   Property wrappers + configuration = reusable, customizable behavior [OK]

Hint: Think: reusable behavior + custom settings [OK]

Common Mistakes:

• Confusing property wrappers with new data types
• Thinking wrappers replace functions
• Assuming wrappers auto-generate UI

2. Which of the following is the correct syntax to declare a property wrapper with a configuration parameter in Swift?

easy

A. @propertyWrapper struct Wrapper { var wrappedValue: Int; init(wrappedValue: Int, config: Bool) { self.wrappedValue = wrappedValue } }

B. @propertyWrapper struct Wrapper { var wrappedValue: Int }

C. struct Wrapper { var wrappedValue: Int; init(config: Bool) { self.wrappedValue = 0 } }

D. @propertyWrapper struct Wrapper { var wrappedValue: Int; func config() {} }

Solution

1. Step 1: Identify property wrapper syntax

   Property wrappers use @propertyWrapper and must have wrappedValue.

2. Step 2: Check for configuration parameter

   Configuration is passed via an initializer with extra parameters besides wrappedValue.

3. Final Answer:

   @propertyWrapper struct Wrapper { var wrappedValue: Int; init(wrappedValue: Int, config: Bool) { self.wrappedValue = wrappedValue } } -> Option A

4. Quick Check:

   Property wrapper + init with config = @propertyWrapper struct Wrapper { var wrappedValue: Int; init(wrappedValue: Int, config: Bool) { self.wrappedValue = wrappedValue } } [OK]

Hint: Look for @propertyWrapper + init with config param [OK]

Common Mistakes:

• Missing @propertyWrapper attribute
• No initializer with config parameter
• Using functions instead of init for config

3. Consider this Swift code using a property wrapper with configuration:

@propertyWrapper
struct Clamped {
    private var value: Int
    private let range: ClosedRange<Int>

    var wrappedValue: Int {
        get { value }
        set { value = min(max(newValue, range.lowerBound), range.upperBound) }
    }

    init(wrappedValue: Int, range: ClosedRange<Int>) {
        self.range = range
        self.value = min(max(wrappedValue, range.lowerBound), range.upperBound)
    }
}

struct Example {
    @Clamped(range: 1...10) var number: Int = 5
}

var ex = Example()
ex.number = 15
print(ex.number)

What is the output when this code runs?

medium

A. 10

B. 5

C. 15

D. 1

Solution

1. Step 1: Understand the Clamped wrapper behavior

   The wrapper clamps the value between the given range (1 to 10).

2. Step 2: Analyze the assignment and print

   Assigning 15 triggers clamping to upper bound 10, so print outputs 10.

3. Final Answer:

   10 -> Option A

4. Quick Check:

   Value clamped to 10 [OK]

Hint: Remember clamping limits values to range [OK]

Common Mistakes:

• Expecting original value 15 to print
• Confusing initial value 5 with final
• Ignoring clamping logic in setter

4. This Swift code attempts to use a property wrapper with configuration but causes a compile error:

@propertyWrapper
struct Limited {
    var wrappedValue: Int
    let max: Int

    init(max: Int) {
        self.max = max
        self.wrappedValue = 0
    }
}

struct Data {
    @Limited(max: 100) var score: Int = 50
}

What is the main reason for the error?

medium

A. Cannot assign default value to score when using wrapper

B. Missing init(wrappedValue:max:) initializer to accept initial value

C. Property wrapper cannot have stored properties

D. The max property must be var, not let

Solution

1. Step 1: Check property wrapper initializer requirements

   When using a default value on a wrapped property, the wrapper needs an initializer init(wrappedValue:max:) to accept it.

2. Step 2: Identify missing initializer

   The code only has init(max:), so compiler cannot match score: Int = 50.

3. Final Answer:

   Missing init(wrappedValue:max:) initializer to accept initial value -> Option B

4. Quick Check:

   Init must accept wrappedValue when default given [OK]

Hint: Add init(wrappedValue:..., config...) for default values [OK]

Common Mistakes:

• Thinking stored properties are disallowed
• Believing default value assignment is invalid
• Confusing let/var for causing error

5. You want to create a property wrapper Validated that checks a string against a minimum length and a regular expression pattern, both configurable. Which approach correctly supports this configuration and usage?

@propertyWrapper
struct Validated {
    private var value: String
    private let minLength: Int
    private let pattern: String

    var wrappedValue: String {
        get { value }
        set {
            if newValue.count >= minLength && newValue.range(of: pattern, options: .regularExpression) != nil {
                value = newValue
            } else {
                value = ""
            }
        }
    }

    // What initializer should be here?
}

struct User {
    @Validated(minLength: 5, pattern: "^[a-zA-Z]+$") var username: String = ""
}

hard

A. init() { self.minLength = 0; self.pattern = ".*"; self.value = "" }

B. init(minLength: Int, pattern: String) { self.minLength = minLength; self.pattern = pattern; self.value = "" }

C. init(wrappedValue: String, minLength: Int, pattern: String) { self.minLength = minLength; self.pattern = pattern; self.value = wrappedValue }

D. init(wrappedValue: String) { self.minLength = 0; self.pattern = ".*"; self.value = wrappedValue }

Solution

1. Step 1: Understand usage with default value and config

   The property username has a default value and two config parameters, so the wrapper needs an initializer accepting all three.

2. Step 2: Match initializer signature

   Only an initializer with wrappedValue, minLength, and pattern parameters can initialize all properties correctly.

3. Final Answer:

   init(wrappedValue: String, minLength: Int, pattern: String) { self.minLength = minLength; self.pattern = pattern; self.value = wrappedValue } -> Option C

4. Quick Check:

   Init must accept wrappedValue + config params [OK]

Hint: Init must accept wrappedValue plus all config parameters [OK]

Common Mistakes:

• Omitting wrappedValue in initializer
• Not initializing all stored properties
• Using init without parameters when config is needed