A type that provides the sequence’s iteration interface and encapsulates its iteration state.
SDK
- Xcode 10.0+
Framework
- Swift Standard Library
Declaration
@frozen struct Iterator
StructureFlatten
FlattenSequence.Iterator
Topics
Type Aliases
typealias FlattenSequence.Iterator.Element The type of element traversed by the iterator.
typealias FlattenSequence.Iterator.Iterator A type that provides the sequence’s iteration interface and encapsulates its iteration state.
Instance Properties
var lazy: LazySequence<FlattenSequence<Base>.Iterator> A sequence containing the same elements as this sequence, but on which some operations, such as map and filter, are implemented lazily.
var underestimatedCount : IntA value less than or equal to the number of elements in the sequence, calculated nondestructively.
Instance Methods
func allSatisfy ((Base.Element.Element) -> Bool) -> Bool Returns a Boolean value indicating whether every element of a sequence satisfies a given predicate.
func compactMap <ElementOfResult>((Base.Element.Element) -> ElementOfResult?) -> [ElementOfResult] Returns an array containing the non-nil results of calling the given transformation with each element of this sequence.
func contains(Base.Element.Element) -> Bool Returns a Boolean value indicating whether the sequence contains the given element.
func contains(where: (Base.Element.Element) -> Bool) -> Bool Returns a Boolean value indicating whether the sequence contains an element that satisfies the given predicate.
func drop(while: (Base.Element.Element) -> Bool) -> DropWhileSequence<FlattenSequence<Base>.Iterator> Returns a sequence by skipping the initial, consecutive elements that satisfy the given predicate.
func dropFirst (Int) -> DropFirstSequence<FlattenSequence<Base>.Iterator> Returns a sequence containing all but the given number of initial elements.
func dropLast (Int) -> [Base.Element.Element] Returns a sequence containing all but the given number of final elements.
func elementsEqual <OtherSequence>(OtherSequence) -> Bool Returns a Boolean value indicating whether this sequence and another sequence contain the same elements in the same order.
func elementsEqual <OtherSequence>(OtherSequence, by: (Base.Element.Element, OtherSequence.Element) -> Bool) -> Bool Returns a Boolean value indicating whether this sequence and another sequence contain equivalent elements in the same order, using the given predicate as the equivalence test.
func enumerated() -> EnumeratedSequence<FlattenSequence<Base>.Iterator> Returns a sequence of pairs (n, x), where n represents a consecutive integer starting at zero and x represents an element of the sequence.
func filter((Base.Element.Element) -> Bool) -> [Base.Element.Element] Returns an array containing, in order, the elements of the sequence that satisfy the given predicate.
func first(where: (Base.Element.Element) -> Bool) -> Base.Element.Element? Returns the first element of the sequence that satisfies the given predicate.
func flatMap <SegmentOfResult>((Base.Element.Element) -> SegmentOfResult) -> [SegmentOfResult.Element] Returns an array containing the concatenated results of calling the given transformation with each element of this sequence.
func flatMap <ElementOfResult>((Base.Element.Element) -> ElementOfResult?) -> [ElementOfResult] Returns an array containing the non-nil results of calling the given transformation with each element of this sequence.
func forEach ((Base.Element.Element) -> Void) Calls the given closure on each element in the sequence in the same order as a for-in loop.
func joined() -> FlattenSequence<FlattenSequence<Base>.Iterator> Returns the elements of this sequence of sequences, concatenated.
func joined<Separator>(separator: Separator) -> JoinedSequence<FlattenSequence<Base>.Iterator> Returns the concatenated elements of this sequence of sequences, inserting the given separator between each element.
func joined(separator: String) -> StringReturns a new string by concatenating the elements of the sequence, adding the given separator between each element.
func lexicographicallyPrecedes <OtherSequence>(OtherSequence) -> Bool Returns a Boolean value indicating whether the sequence precedes another sequence in a lexicographical (dictionary) ordering, using the less-than operator (<) to compare elements.
func lexicographicallyPrecedes <OtherSequence>(OtherSequence, by: (Base.Element.Element, Base.Element.Element) -> Bool) -> Bool Returns a Boolean value indicating whether the sequence precedes another sequence in a lexicographical (dictionary) ordering, using the given predicate to compare elements.
func makeIterator () -> FlattenSequence<Base>.Iterator Returns an iterator over the elements of this sequence.
func map<T>((Base.Element.Element) -> T) -> [T] Returns an array containing the results of mapping the given closure over the sequence’s elements.
func max() -> Base.Element.Element? Returns the maximum element in the sequence.
func max(by: (Base.Element.Element, Base.Element.Element) -> Bool) -> Base.Element.Element? Returns the maximum element in the sequence, using the given predicate as the comparison between elements.
func min() -> Base.Element.Element? Returns the minimum element in the sequence.
func min(by: (Base.Element.Element, Base.Element.Element) -> Bool) -> Base.Element.Element? Returns the minimum element in the sequence, using the given predicate as the comparison between elements.
func next() -> FlattenSequence<Base>.Iterator.Element? Advances to the next element and returns it, or nil if no next element exists.
func prefix(Int) -> PrefixSequence<FlattenSequence<Base>.Iterator> Returns a sequence, up to the specified maximum length, containing the initial elements of the sequence.
func prefix(while: (Base.Element.Element) -> Bool) -> [Base.Element.Element] Returns a sequence containing the initial, consecutive elements that satisfy the given predicate.
func reduce<Result>(Result, (Result, Base.Element.Element) -> Result) -> Result Returns the result of combining the elements of the sequence using the given closure.
func reduce<Result>(into: Result, (inout Result, Base.Element.Element) -> ()) -> Result Returns the result of combining the elements of the sequence using the given closure.
func reversed() -> [Base.Element.Element] Returns an array containing the elements of this sequence in reverse order.
func shuffled() -> [Base.Element.Element] Returns the elements of the sequence, shuffled.
func shuffled<T>(using: inout T) -> [Base.Element.Element] Returns the elements of the sequence, shuffled using the given generator as a source for randomness.
func sorted() -> [Base.Element.Element] Returns the elements of the sequence, sorted.
func sorted(by: (Base.Element.Element, Base.Element.Element) -> Bool) -> [Base.Element.Element] Returns the elements of the sequence, sorted using the given predicate as the comparison between elements.
func split(maxSplits : Int, omittingEmptySubsequences : Bool, whereSeparator : (Base.Element.Element) -> Bool) -> [ArraySlice<Base.Element.Element>] Returns the longest possible subsequences of the sequence, in order, that don’t contain elements satisfying the given predicate. Elements that are used to split the sequence are not returned as part of any subsequence.
func split(separator: Base.Element.Element, maxSplits : Int, omittingEmptySubsequences : Bool) -> [ArraySlice<Base.Element.Element>] Returns the longest possible subsequences of the sequence, in order, around elements equal to the given element.
func starts<PossiblePrefix>( with: PossiblePrefix) -> Bool Returns a Boolean value indicating whether the initial elements of the sequence are the same as the elements in another sequence.
func starts<PossiblePrefix>( with: PossiblePrefix, by: (Base.Element.Element, PossiblePrefix.Element) -> Bool) -> Bool Returns a Boolean value indicating whether the initial elements of the sequence are equivalent to the elements in another sequence, using the given predicate as the equivalence test.
func suffix(Int) -> [Base.Element.Element] Returns a subsequence, up to the given maximum length, containing the final elements of the sequence.
func withContiguousStorageIfAvailable <R>((UnsafeBufferPointer<Base.Element.Element>) -> R) -> R? Call body(p), where p is a pointer to the collection’s contiguous storage. If no such storage exists, it is first created. If the collection does not support an internal representation in a form of contiguous storage, body is not called and nil is returned.