File: TreeDictionary%2BSequence.swift

package info (click to toggle)
swiftlang 6.0.3-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,519,992 kB
  • sloc: cpp: 9,107,863; ansic: 2,040,022; asm: 1,135,751; python: 296,500; objc: 82,456; f90: 60,502; lisp: 34,951; pascal: 19,946; sh: 18,133; perl: 7,482; ml: 4,937; javascript: 4,117; makefile: 3,840; awk: 3,535; xml: 914; fortran: 619; cs: 573; ruby: 573
file content (73 lines) | stat: -rw-r--r-- 2,291 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift Collections open source project
//
// Copyright (c) 2019 - 2024 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See https://swift.org/LICENSE.txt for license information
//
//===----------------------------------------------------------------------===//

extension TreeDictionary: Sequence {
  /// The element type of a dictionary: a tuple containing an individual
  /// key-value pair.
  public typealias Element = (key: Key, value: Value)

  /// The type that allows iteration over a persistent dictionary's elements.
  @frozen
  public struct Iterator {
    // Fixed-stack iterator for traversing a hash tree.
    // The iterator performs a pre-order traversal, with items at a node visited
    // before any items within children.

    @usableFromInline
    internal typealias _UnsafeHandle = _Node.UnsafeHandle

    @usableFromInline
    internal var _it: _HashTreeIterator

    @inlinable
    internal init(_root: _RawHashNode) {
      self._it = _HashTreeIterator(root: _root)
    }
  }

  /// A value less than or equal to the number of elements in the sequence,
  /// calculated nondestructively.
  ///
  /// - Complexity: O(1)
  @inlinable
  public var underestimatedCount: Int {
    _root.count
  }

  /// Returns an iterator over the elements of this collection.
  ///
  /// - Complexity: O(1)
  @inlinable
  public __consuming func makeIterator() -> Iterator {
    return Iterator(_root: _root.raw)
  }
}

extension TreeDictionary.Iterator: @unchecked Sendable
where Key: Sendable, Value: Sendable {}

extension TreeDictionary.Iterator: IteratorProtocol {
  /// The element type of a dictionary: a tuple containing an individual
  /// key-value pair.
  public typealias Element = (key: Key, value: Value)

  /// Advances to the next element and returns it, or `nil` if no next
  /// element exists.
  ///
  /// Once `nil` has been returned, all subsequent calls return `nil`.
  ///
  /// - Complexity: O(1)
  @inlinable
  public mutating func next() -> Element? {
    guard let (node, slot) = _it.next() else { return nil }
    return _UnsafeHandle.read(node) { $0[item: slot] }
  }
}