NSArray
You’re reading documentation from an older version of Swift 6.1.
A symbol with the same signature as this one exists in the latest stable release of Swift 6.1.
class NSArrayYou’re reading documentation from an older version of Swift 6.1.
A symbol with the same signature as this one exists in the latest stable release of Swift 6.1.
class NSArrayimport Foundationclass NSObjectThe root class of most Foundation class hierarchies.
protocol CopyableA type whose values can be implicitly or explicitly copied.
protocol CustomDebugStringConvertibleA type with a customized textual representation suitable for debugging purposes.
protocol CustomReflectableA type that explicitly supplies its own mirror.
protocol CustomStringConvertibleA type with a customized textual representation.
protocol EquatableA type that can be compared for value equality.
protocol Escapableprotocol ExpressibleByArrayLiteralA type that can be initialized using an array literal.
protocol Hashable : EquatableA type that can be hashed into a Hasher to produce an integer hash value.
protocol NSCodingThe NSCoding protocol declares the two methods that a class must implement so that instances of that class can be encoded and decoded. This capability provides the basis for archiving (where objects and other structures are stored on disk) and distribution (where objects are copied to different address spaces).
protocol NSCopyingThe NSCopying protocol declares a method for providing functional copies of an object. The exact meaning of “copy” can vary from class to class, but a copy must be a functionally independent object with values identical to the original at the time the copy was made.
protocol NSMutableCopyingThe NSMutableCopying protocol declares a method for providing mutable copies of an object. Only classes that define an “immutable vs. mutable” distinction should adopt this protocol. Classes that don’t define such a distinction should adopt NSCopying instead.
protocol NSObjectProtocol : AnyObjectThe NSObjectProtocol groups methods that are fundamental to all Foundation objects.
protocol NSSecureCoding : NSCodingConforming to the NSSecureCoding protocol indicates that an object handles encoding and decoding instances of itself in a manner that is robust against object substitution attacks.
protocol Sequence<Element>A type that provides sequential, iterated access to its elements.
override init() convenience init(array: NSArray) convenience init(array: [Any]) convenience init(array: [Any], copyItems: Bool) required convenience init(arrayLiteral elements: Any...) required convenience init?(coder aDecoder: NSCoder) convenience init(contentsOf url: URL, error: ()) throws convenience init(object anObject: Any) convenience init(objects elements: AnyObject...) required init(objects: UnsafePointer<AnyObject>?, count: Int) convenience init(objects: UnsafePointer<AnyObject>, count: Int) static var supportsSecureCoding: Bool { get }var count: Int { get }var customMirror: Mirror { get }override var description: String { get }var firstObject: Any? { get }override var hash: Int { get }var lastObject: Any? { get }var sortedArrayHint: Data { get }subscript(idx: Int) -> Any { get } func adding(_ anObject: Any) -> [Any] func addingObjects(from otherArray: [Any]) -> [Any] func componentsJoined(by separator: String) -> String func contains(_ anObject: Any) -> Bool override func copy() -> Any func copy(with zone: NSZone? = nil) -> Any func description(withLocale locale: Locale?) -> String func description(withLocale locale: Locale?, indent level: Int) -> String func encode(with aCoder: NSCoder) func enumerateObjects(_ block: (Any, Int, UnsafeMutablePointer<ObjCBool>) -> Void) func enumerateObjects(at s: IndexSet, options opts: NSEnumerationOptions = [], using block: (Any, Int, UnsafeMutablePointer<ObjCBool>) -> Void) func enumerateObjects(options opts: NSEnumerationOptions = [], using block: (Any, Int, UnsafeMutablePointer<ObjCBool>) -> Void) func filtered(using predicate: NSPredicate) -> [Any] func firstObjectCommon(with otherArray: [Any]) -> Any? func index(of anObject: Any) -> Int func index(of anObject: Any, in range: NSRange) -> Int func index(of obj: Any, inSortedRange r: NSRange, options opts: NSBinarySearchingOptions = [], usingComparator cmp: (Any, Any) -> ComparisonResult) -> Int func indexOfObject(at s: IndexSet, options opts: NSEnumerationOptions = [], passingTest predicate: (Any, Int, UnsafeMutablePointer<ObjCBool>) -> Bool) -> Int func indexOfObject(options opts: NSEnumerationOptions = [], passingTest predicate: (Any, Int, UnsafeMutablePointer<ObjCBool>) -> Bool) -> Int func indexOfObject(passingTest predicate: (Any, Int, UnsafeMutablePointer<ObjCBool>) -> Bool) -> Int func indexOfObjectIdentical(to anObject: Any) -> Int func indexOfObjectIdentical(to anObject: Any, in range: NSRange) -> Int func indexesOfObjects(at s: IndexSet, options opts: NSEnumerationOptions = [], passingTest predicate: (Any, Int, UnsafeMutablePointer<ObjCBool>) -> Bool) -> IndexSet func indexesOfObjects(options opts: NSEnumerationOptions = [], passingTest predicate: (Any, Int, UnsafeMutablePointer<ObjCBool>) -> Bool) -> IndexSet func indexesOfObjects(passingTest predicate: (Any, Int, UnsafeMutablePointer<ObjCBool>) -> Bool) -> IndexSet override func isEqual(_ value: Any?) -> Bool func isEqual(to otherArray: [Any]) -> Bool final func makeIterator() -> NSArray.Iterator override func mutableCopy() -> Any func mutableCopy(with zone: NSZone? = nil) -> Any func object(at index: Int) -> Any func objectEnumerator() -> NSEnumerator func objects(at indexes: IndexSet) -> [Any] func pathsMatchingExtensions(_ filterTypes: [String]) -> [String] func reverseObjectEnumerator() -> NSEnumerator func sortedArray(_ comparator: (Any, Any, UnsafeMutableRawPointer?) -> Int, context: UnsafeMutableRawPointer?) -> [Any] func sortedArray(_ comparator: (Any, Any, UnsafeMutableRawPointer?) -> Int, context: UnsafeMutableRawPointer?, hint: Data?) -> [Any] func sortedArray(comparator cmptr: (Any, Any) -> ComparisonResult) -> [Any] func sortedArray(options opts: NSSortOptions = [], usingComparator cmptr: (Any, Any) -> ComparisonResult) -> [Any] func sortedArray(using sortDescriptors: [NSSortDescriptor]) -> [Any] func subarray(with range: NSRange) -> [Any] func write(to url: URL) throws struct Iteratorconvenience init?(contentsOf url: URL) convenience init?(contentsOfFile path: String) @discardableResult func write(to url: URL, atomically: Bool) -> Bool @discardableResult func write(toFile path: String, atomically useAuxiliaryFile: Bool) -> Bool var lazy: LazySequence<Self> { get }A sequence containing the same elements as this sequence, but on which some operations, such as map and filter, are implemented lazily.
var underestimatedCount: Int { get }A value less than or equal to the number of elements in the sequence, calculated nondestructively.
func allSatisfy(_ predicate: (Self.Element) throws -> Bool) rethrows -> Bool Returns a Boolean value indicating whether every element of a sequence satisfies a given predicate.
func compactMap<ElementOfResult>(_ transform: (Self.Element) throws -> ElementOfResult?) rethrows -> [ElementOfResult] Returns an array containing the non-nil results of calling the given transformation with each element of this sequence.
func compare<Comparator>(_ lhs: Comparator.Compared, _ rhs: Comparator.Compared) -> ComparisonResult where Comparator : SortComparator, Comparator == Self.Element If lhs is ordered before rhs in the ordering described by the given sequence of SortComparators
func contains(where predicate: (Self.Element) throws -> Bool) rethrows -> Bool Returns a Boolean value indicating whether the sequence contains an element that satisfies the given predicate.
func count<E>(where predicate: (Self.Element) throws(E) -> Bool) throws(E) -> Int where E : Error Returns the number of elements in the sequence that satisfy the given predicate.
func drop(while predicate: (Self.Element) throws -> Bool) rethrows -> DropWhileSequence<Self> Returns a sequence by skipping the initial, consecutive elements that satisfy the given predicate.
func dropFirst(_ k: Int = 1) -> DropFirstSequence<Self> Returns a sequence containing all but the given number of initial elements.
func dropLast(_ k: Int = 1) -> [Self.Element] Returns a sequence containing all but the given number of final elements.
func elementsEqual<OtherSequence>(_ other: OtherSequence, by areEquivalent: (Self.Element, OtherSequence.Element) throws -> Bool) rethrows -> Bool where OtherSequence : Sequence 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<Self> 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(_ isIncluded: (Self.Element) throws -> Bool) rethrows -> [Self.Element] Returns an array containing, in order, the elements of the sequence that satisfy the given predicate.
func filter(_ predicate: Predicate<Self.Element>) throws -> [Self.Element] func first(where predicate: (Self.Element) throws -> Bool) rethrows -> Self.Element? Returns the first element of the sequence that satisfies the given predicate.
func flatMap<SegmentOfResult>(_ transform: (Self.Element) throws -> SegmentOfResult) rethrows -> [SegmentOfResult.Element] where SegmentOfResult : Sequence Returns an array containing the concatenated results of calling the given transformation with each element of this sequence.
func forEach(_ body: (Self.Element) throws -> Void) rethrows Calls the given closure on each element in the sequence in the same order as a for-in loop.
func formatted<S>(_ style: S) -> S.FormatOutput where Self == S.FormatInput, S : FormatStyle func lexicographicallyPrecedes<OtherSequence>(_ other: OtherSequence, by areInIncreasingOrder: (Self.Element, Self.Element) throws -> Bool) rethrows -> Bool where OtherSequence : Sequence, Self.Element == OtherSequence.Element Returns a Boolean value indicating whether the sequence precedes another sequence in a lexicographical (dictionary) ordering, using the given predicate to compare elements.
func map<T, E>(_ transform: (Self.Element) throws(E) -> T) throws(E) -> [T] where E : Error Returns an array containing the results of mapping the given closure over the sequence’s elements.
@warn_unqualified_access func max(by areInIncreasingOrder: (Self.Element, Self.Element) throws -> Bool) rethrows -> Self.Element? Returns the maximum element in the sequence, using the given predicate as the comparison between elements.
@warn_unqualified_access func min(by areInIncreasingOrder: (Self.Element, Self.Element) throws -> Bool) rethrows -> Self.Element? Returns the minimum element in the sequence, using the given predicate as the comparison between elements.
func prefix(_ maxLength: Int) -> PrefixSequence<Self> Returns a sequence, up to the specified maximum length, containing the initial elements of the sequence.
func prefix(while predicate: (Self.Element) throws -> Bool) rethrows -> [Self.Element] Returns a sequence containing the initial, consecutive elements that satisfy the given predicate.
func reduce<Result>(_ initialResult: Result, _ nextPartialResult: (Result, Self.Element) throws -> Result) rethrows -> Result Returns the result of combining the elements of the sequence using the given closure.
func reduce<Result>(into initialResult: Result, _ updateAccumulatingResult: (inout Result, Self.Element) throws -> ()) rethrows -> Result Returns the result of combining the elements of the sequence using the given closure.
func reversed() -> [Self.Element] Returns an array containing the elements of this sequence in reverse order.
func shuffled() -> [Self.Element] Returns the elements of the sequence, shuffled.
func shuffled<T>(using generator: inout T) -> [Self.Element] where T : RandomNumberGenerator Returns the elements of the sequence, shuffled using the given generator as a source for randomness.
func sorted(by areInIncreasingOrder: (Self.Element, Self.Element) throws -> Bool) rethrows -> [Self.Element] Returns the elements of the sequence, sorted using the given predicate as the comparison between elements.
func sorted<Comparator>(using comparator: Comparator) -> [Self.Element] where Comparator : SortComparator, Self.Element == Comparator.Compared Returns the elements of the sequence, sorted using the given comparator to compare elements.
func sorted<S, Comparator>(using comparators: S) -> [Self.Element] where S : Sequence, Comparator : SortComparator, Comparator == S.Element, Self.Element == Comparator.Compared Returns the elements of the sequence, sorted using the given array of SortComparators to compare elements.
func split(maxSplits: Int = Int.max, omittingEmptySubsequences: Bool = true, whereSeparator isSeparator: (Self.Element) throws -> Bool) rethrows -> [ArraySlice<Self.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 starts<PossiblePrefix>(with possiblePrefix: PossiblePrefix, by areEquivalent: (Self.Element, PossiblePrefix.Element) throws -> Bool) rethrows -> Bool where PossiblePrefix : Sequence 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(_ maxLength: Int) -> [Self.Element] Returns a subsequence, up to the given maximum length, containing the final elements of the sequence.
func withContiguousStorageIfAvailable<R>(_ body: (UnsafeBufferPointer<Self.Element>) throws -> R) rethrows -> R? func flatMap<ElementOfResult>(_ transform: (Self.Element) throws -> ElementOfResult?) rethrows -> [ElementOfResult] class NSMutableArrayimport VaporVapor is a framework for building server applications, APIs and websites in Swift. It provides a safe, performant and scalable foundation for building large complex backends.
func adjacentPairs() -> AdjacentPairsSequence<Self> Returns a sequence of overlapping adjacent pairs of the elements of this sequence.
func compacted<Unwrapped>() -> CompactedSequence<Self, Unwrapped> where Self.Element == Unwrapped? Returns a new Sequence that iterates over every non-nil element from the original Sequence.
func firstNonNil<Result>(_ transform: (Element) throws -> Result?) rethrows -> Result? Returns the first non-nil result obtained from applying the given transformation to the elements of the sequence.
func grouped<GroupKey>(by keyForValue: (Element) throws -> GroupKey) rethrows -> [GroupKey : [Element]] where GroupKey : Hashable Groups up elements of self into a new Dictionary, whose values are Arrays of grouped elements, each keyed by the group key returned by the given closure.
func interspersed(with separator: Element) -> InterspersedSequence<Self> Returns a sequence containing elements of this sequence with the given separator inserted in between each element.
func keyed<Key>(by keyForValue: (Element) throws -> Key) rethrows -> [Key : Element] where Key : Hashable Creates a new Dictionary from the elements of self, keyed by the results returned by the given keyForValue closure.
func keyed<Key>(by keyForValue: (Element) throws -> Key, resolvingConflictsWith resolve: (Key, Element, Element) throws -> Element) rethrows -> [Key : Element] where Key : Hashable Creates a new Dictionary from the elements of self, keyed by the results returned by the given keyForValue closure. As the dictionary is built, the initializer calls the resolve closure with the current and new values for any duplicate keys. Pass a closure as resolve that returns the value to use in the resulting dictionary: The closure can choose between the two values, combine them to produce a new value, or even throw an error.
func max(count: Int, sortedBy areInIncreasingOrder: (Element, Element) throws -> Bool) rethrows -> [Element] Returns the largest elements of this sequence, as sorted by the given predicate.
func min(count: Int, sortedBy areInIncreasingOrder: (Element, Element) throws -> Bool) rethrows -> [Element] Returns the smallest elements of this sequence, as sorted by the given predicate.
func minAndMax(by areInIncreasingOrder: (Element, Element) throws -> Bool) rethrows -> (min: Element, max: Element)? Returns both the minimum and maximum elements in the sequence, using the given predicate as the comparison between elements.
func partitioned(by predicate: (Element) throws -> Bool) rethrows -> (falseElements: [Element], trueElements: [Element]) Returns two arrays containing the elements of the sequence that don’t and do satisfy the given predicate, respectively.
func randomSample(count k: Int) -> [Element] Randomly selects the specified number of elements from this sequence.
func randomSample<G>(count k: Int, using rng: inout G) -> [Element] where G : RandomNumberGenerator Randomly selects the specified number of elements from this sequence.
func reductions(_ transform: (Element, Element) throws -> Element) rethrows -> [Element] Returns an array containing the accumulated results of combining the elements of the sequence using the given closure.
func reductions<Result>(_ initial: Result, _ transform: (Result, Element) throws -> Result) rethrows -> [Result] Returns an array containing the accumulated results of combining the elements of the sequence using the given closure.
func reductions<Result>(into initial: Result, _ transform: (inout Result, Element) throws -> Void) rethrows -> [Result] Returns an array containing the accumulated results of combining the elements of the sequence using the given closure.
func striding(by step: Int) -> StridingSequence<Self> Returns a sequence stepping through the elements every step starting at the first value. Any remainders of the stride will be trimmed.
func uniqued<Subject>(on projection: (Element) throws -> Subject) rethrows -> [Element] where Subject : Hashable Returns an array with the unique elements of this sequence (as determined by the given projection), in the order of the first occurrence of each unique element.
func scan(_ transform: (Element, Element) throws -> Element) rethrows -> [Element] func scan<Result>(_ initial: Result, _ transform: (Result, Element) throws -> Result) rethrows -> [Result] func scan<Result>(into initial: Result, _ transform: (inout Result, Element) throws -> Void) rethrows -> [Result]