Async sequences (AsyncSequence) in Swift

Introduction

Async sequences let you work with values that come over time, like waiting for messages or data without stopping your program.

When you want to handle data that arrives slowly, like user input or network responses.

When you need to process events one by one as they happen, such as button taps or sensor updates.

When reading lines from a file or stream without blocking the app.

When you want to write clean code that waits for multiple values asynchronously.

When you want to combine or transform streams of data easily.

Syntax

Swift

struct MyAsyncSequence: AsyncSequence {
    typealias Element = Int

    struct AsyncIterator: AsyncIteratorProtocol {
        var current = 0

        mutating func next() async -> Int? {
            guard current < 5 else { return nil }
            defer { current += 1 }
            return current
        }
    }

    func makeAsyncIterator() -> AsyncIterator {
        AsyncIterator()
    }
}

An AsyncSequence must define an AsyncIterator that produces values asynchronously.

The next() method returns the next value or nil when done.

Examples

This loops over the async sequence and prints each number as it arrives.

Swift

for await number in MyAsyncSequence() {
    print(number)
}

This manually creates an iterator and fetches values one by one inside an async task.

Swift

let numbers = MyAsyncSequence()
var iterator = numbers.makeAsyncIterator()

Task {
    while let number = await iterator.next() {
        print(number)
    }
}

Sample Program

This program counts down from 3 to 1, waiting half a second between each number, then prints "Blast off!".

Swift

import Foundation

struct Countdown: AsyncSequence {
    typealias Element = Int

    struct AsyncIterator: AsyncIteratorProtocol {
        var count: Int

        mutating func next() async -> Int? {
            guard count > 0 else { return nil }
            try? await Task.sleep(nanoseconds: 500_000_000) // wait 0.5 seconds
            defer { count -= 1 }
            return count
        }
    }

    let start: Int

    func makeAsyncIterator() -> AsyncIterator {
        AsyncIterator(count: start)
    }
}

@main
struct Main {
    static func main() async {
        let countdown = Countdown(start: 3)
        for await number in countdown {
            print("Countdown: \(number)")
        }
        print("Blast off!")
    }
}

Important Notes

Use for await to loop over async sequences easily.

Async sequences help keep your app responsive by not blocking while waiting for data.

Remember to mark functions using async sequences with async and run them in async contexts.

Summary

Async sequences let you handle streams of values that come over time without blocking.

Define an AsyncIterator with a next() method that returns values asynchronously.

Use for await loops to process these values simply and clearly.

Practice

1. What is the main purpose of using AsyncSequence in Swift?

easy

A. To create synchronous loops that block until completion

B. To define static arrays with fixed values

C. To handle streams of values that arrive over time without blocking the program

D. To perform immediate calculations without delay

Solution

1. Step 1: Understand AsyncSequence purpose

   AsyncSequence is designed to handle values that come asynchronously over time, like events or data streams.

2. Step 2: Compare options with AsyncSequence use

   Only To handle streams of values that arrive over time without blocking the program correctly describes handling streams without blocking, which is the key feature of AsyncSequence.

3. Final Answer:

   To handle streams of values that arrive over time without blocking the program -> Option C

4. Quick Check:

   AsyncSequence = handle async streams [OK]

Hint: AsyncSequence handles values arriving over time without blocking [OK]

Common Mistakes:

• Confusing AsyncSequence with synchronous loops
• Thinking AsyncSequence is for static data
• Assuming it blocks program execution

2. Which of the following is the correct syntax to iterate over an AsyncSequence named numbers?

easy

A. for await number in numbers { print(number) }

B. for number in numbers { print(number) }

C. while let number = numbers.next() { print(number) }

D. numbers.forEach { print($0) }

Solution

1. Step 1: Recall AsyncSequence iteration syntax

   AsyncSequence requires asynchronous iteration using for await to wait for values.

2. Step 2: Check each option

   for await number in numbers { print(number) } uses for await, which is correct. for number in numbers { print(number) } is synchronous, C is invalid syntax for AsyncSequence, and D is not supported.

3. Final Answer:

   for await number in numbers { print(number) } -> Option A

4. Quick Check:

   AsyncSequence loops use for await [OK]

Hint: Use 'for await' to loop over AsyncSequence values [OK]

Common Mistakes:

• Using regular for loop without await
• Trying to call next() synchronously
• Using forEach which is not async-compatible

3. What will be printed by the following Swift code?

struct Counter: AsyncSequence {
  typealias Element = Int
  struct AsyncIterator: AsyncIteratorProtocol {
    var count = 1
    mutating func next() async -> Int? {
      guard count <= 3 else { return nil }
      defer { count += 1 }
      return count
    }
  }
  func makeAsyncIterator() -> AsyncIterator {
    AsyncIterator()
  }
}

let counter = Counter()
Task {
  for await number in counter {
    print(number)
  }
}

medium

A. 1 2 3

B. 0 1 2

C. 1 2 3 4

D. No output, code will not compile

Solution

1. Step 1: Analyze AsyncIterator next() method

   The iterator returns count starting at 1, increments after returning, and stops after 3.

2. Step 2: Trace iteration values

   Values returned are 1, then 2, then 3, then nil to end the loop.

3. Final Answer:

   1 2 3 -> Option A

4. Quick Check:

   AsyncSequence yields 1,2,3 then ends [OK]

Hint: Check next() return and guard condition carefully [OK]

Common Mistakes:

• Assuming count starts at 0
• Forgetting defer increments count after return
• Expecting 4 as output

4. Identify the error in this AsyncSequence implementation:

struct SimpleAsync: AsyncSequence {
  typealias Element = String
  struct AsyncIterator: AsyncIteratorProtocol {
    func next() async -> String? {
      return "Hello"
    }
  }
  func makeAsyncIterator() -> AsyncIterator {
    AsyncIterator()
  }
}

medium

A. makeAsyncIterator() must be async

B. next() should be mutating to update state

C. AsyncIterator must be a class, not a struct

D. Element type cannot be String

Solution

1. Step 1: Understand AsyncIteratorProtocol requirements

   The next() method often needs to update internal state, so it must be marked mutating in a struct.

2. Step 2: Check the code's next() method

   Here, next() is not mutating but returns a constant string repeatedly, which is incorrect for iteration.

3. Final Answer:

   next() should be mutating to update state -> Option B

4. Quick Check:

   next() mutating required in struct iterator [OK]

Hint: next() in struct iterator must be mutating if state changes [OK]

Common Mistakes:

• Thinking AsyncIterator must be a class
• Making makeAsyncIterator async unnecessarily
• Believing String cannot be Element type

5. You want to create an AsyncSequence that emits only even numbers from 2 to 10 inclusive. Which implementation correctly achieves this?

hard

A. struct EvenNumbers: AsyncSequence {
typealias Element = Int
struct AsyncIterator: AsyncIteratorProtocol {
var current = 2
mutating func next() async -> Int? {
guard current < 10 else { return nil }
defer { current += 2 }
return current
}
}
func makeAsyncIterator() -> AsyncIterator { AsyncIterator() }
}

B. struct EvenNumbers: AsyncSequence {
typealias Element = Int
struct AsyncIterator: AsyncIteratorProtocol {
var current = 1
mutating func next() async -> Int? {
guard current <= 10 else { return nil }
defer { current += 1 }
return current * 2
}
}
func makeAsyncIterator() -> AsyncIterator { AsyncIterator() }
}

C. struct EvenNumbers: AsyncSequence {
typealias Element = Int
struct AsyncIterator: AsyncIteratorProtocol {
var current = 0
mutating func next() async -> Int? {
guard current <= 10 else { return nil }
current += 2
return current
}
}
func makeAsyncIterator() -> AsyncIterator { AsyncIterator() }
}

D. struct EvenNumbers: AsyncSequence {
typealias Element = Int
struct AsyncIterator: AsyncIteratorProtocol {
var current = 2
mutating func next() async -> Int? {
if current > 10 { return nil }
let result = current
current += 2
return result
}
}
func makeAsyncIterator() -> AsyncIterator { AsyncIterator() }
}

Solution

1. Step 1: Identify required sequence

   Even numbers from 2 to 10 inclusive: 2, 4, 6, 8, 10 exactly.

2. Step 2: Trace execution of each

   A (< 10, defer +=2): 2,4,6,8 (stops at current=10). Misses 10.
   B (*2 on odds): 2,4,6,8,10,12,... overshoots.
   C (<=10, +=2 first): 2,4,6,8,10,12 extra.
   D (if >10 nil, result first): 2,4,6,8,10 perfect.

3. Final Answer:

   if current > 10 { return nil }
   let result = current
   current += 2
   return result -> Option D

4. Quick Check:

   Only D emits exactly 2,4,6,8,10 [OK]

Hint: Return current before increment; stop when current > 10 [OK]

Common Mistakes:

• Incrementing before returning causing off-by-one errors
• Incorrect guard conditions excluding last value
• Multiplying inside next() causing wrong sequence