Open ClassFoundation5.9.0
NSData
class NSDataSuperclasses
class NSObjectThe root class of most Foundation class hierarchies.
Citizens in Foundation
Conformances
protocol BidirectionalCollectionA collection that supports backward as well as forward traversal.
protocol CollectionA sequence whose elements can be traversed multiple times, nondestructively, and accessed by an indexed subscript.
protocol CustomDebugStringConvertibleA type with a customized textual representation suitable for debugging purposes.
protocol CustomStringConvertibleA type with a customized textual representation.
protocol DataProtocolprotocol EquatableA type that can be compared for value equality.
protocol HashableA type that can be hashed into a
Hasherto produce an integer hash value.protocol NSCodingThe
NSCodingprotocol 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
NSCopyingprotocol 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
NSMutableCopyingprotocol 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 adoptNSCopyinginstead.protocol NSObjectProtocolThe
NSObjectProtocolgroups methods that are fundamental to all Foundation objects.protocol NSSecureCodingConforming to the
NSSecureCodingprotocol indicates that an object handles encoding and decoding instances of itself in a manner that is robust against object substitution attacks.protocol RandomAccessCollectionA collection that supports efficient random-access index traversal.
protocol SequenceA type that provides sequential, iterated access to its elements.
Members
init() init?(base64Encoded: Data, options: NSData.Base64DecodingOptions) Initializes a data object with the given Base64 encoded data.
init?(base64Encoded: String, options: NSData.Base64DecodingOptions) Initializes a data object with the given Base64 encoded string.
init(bytes: UnsafeRawPointer?, length: Int) Initializes a data object filled with a given number of bytes copied from a given buffer.
init(bytesNoCopy: UnsafeMutableRawPointer, length: Int) Initializes a data object filled with a given number of bytes of data from a given buffer.
init(bytesNoCopy: UnsafeMutableRawPointer, length: Int, deallocator: ((UnsafeMutableRawPointer, Int) -> Void)?) Initializes a data object filled with a given number of bytes of data from a given buffer, with a custom deallocator block. NOTE: the deallocator block here is implicitly @escaping by virtue of it being optional
init(bytesNoCopy: UnsafeMutableRawPointer, length: Int, freeWhenDone: Bool) Initializes a data object filled with a given number of bytes of data from a given buffer.
init?(coder: NSCoder) init?(contentsOf: URL) Initializes a data object with the data from the location specified by a given URL.
init(contentsOf: URL, options: NSData.ReadingOptions) throws Initializes a data object with the data from the location specified by a given URL.
init?(contentsOfFile: String) Initializes a data object with the contents of the file at a given path.
init(contentsOfFile: String, options: NSData.ReadingOptions) throws Initializes a data object with the contents of the file at a given path.
init(data: Data) Initializes a data object with the contents of another data object.
static var supportsSecureCoding: Boolvar bytes: UnsafeRawPointerA pointer to the data object’s contents.
var debugDescription: Stringvar description: StringA string that contains a hexadecimal representation of the data object’s contents in a property list format.
var endIndex: Intvar hash: Intvar length: IntThe number of bytes contained by the data object.
var regions: [Data]var startIndex: Intsubscript(Int) -> UInt8 func base64EncodedData(options: NSData.Base64EncodingOptions) -> Data Creates a Base64, UTF-8 encoded Data from the data object using the given options.
func base64EncodedString(options: NSData.Base64EncodingOptions) -> String Creates a Base64 encoded String from the data object using the given options.
func copy() -> Any func copy(with: NSZone?) -> Any func encode(with: NSCoder) func enumerateBytes((UnsafeRawPointer, NSRange, UnsafeMutablePointer<Bool>) -> Void) Enumerates each range of bytes in the data object using a block. ‘block’ is called once for each contiguous region of memory in the data object (once total for contiguous NSDatas), until either all bytes have been enumerated, or the ‘stop’ parameter is set to true.
func firstRange<D, R>(of: D, in: R) -> Range<Int>? func getBytes(UnsafeMutableRawPointer, length: Int) Copies a number of bytes from the start of the data object into a given buffer.
func getBytes(UnsafeMutableRawPointer, range: NSRange) Copies a range of bytes from the data object into a given buffer.
func isEqual(Any?) -> Bool Returns a Boolean value indicating whether this data object is the same as another.
func isEqual(to: Data) -> Bool func lastRange<D, R>(of: D, in: R) -> Range<Int>? func mutableCopy() -> Any func mutableCopy(with: NSZone?) -> Any func range(of: Data, options: NSData.SearchOptions, in: NSRange) -> NSRange Finds and returns the range of the first occurrence of the given data, within the given range, subject to given options.
func subdata(with: NSRange) -> Data Returns a new data object containing the data object’s bytes that fall within the limits specified by a given range.
func write(to: URL, atomically: Bool) -> Bool Writes the data object’s bytes to the location specified by a given URL. NOTE: the ‘atomically’ flag is ignored if the url is not of a type the supports atomic writes
func write(to: URL, options: NSData.WritingOptions) throws Writes the data object’s bytes to the location specified by a given URL.
func write(toFile: String, atomically: Bool) -> Bool Writes the data object’s bytes to the file specified by a given path. NOTE: the ‘atomically’ flag is ignored if the url is not of a type the supports atomic writes
func write(toFile: String, options: NSData.WritingOptions) throws Writes the data object’s bytes to the file specified by a given path.
struct Base64DecodingOptionsstruct Base64EncodingOptionsstruct ReadingOptionsstruct SearchOptionsstruct WritingOptions
Features
var first: Self.Element?The first element of the collection.
var last: Self.Element?The last element of the collection.
var lazy: LazySequence<Self>A sequence containing the same elements as this sequence, but on which some operations, such as
mapandfilter, are implemented lazily.func all((Self.Element) -> Bool) -> Bool func allSatisfy((Self.Element) throws -> Bool) rethrows -> Bool Returns a Boolean value indicating whether every element of a sequence satisfies a given predicate.
func any((Self.Element) -> Bool) -> Bool func compactMap<ElementOfResult>((Self.Element) throws -> ElementOfResult?) rethrows -> [ElementOfResult] Returns an array containing the non-
nilresults of calling the given transformation with each element of this sequence.func contains(Self.Element) -> Bool Returns a Boolean value indicating whether the sequence contains the given element.
func contains(where: (Self.Element) throws -> Bool) rethrows -> Bool Returns a Boolean value indicating whether the sequence contains an element that satisfies the given predicate.
func convertByOffset<C>(Self.Index, in: C) -> C.Index func convertByOffset<C>(Range<Self.Index>, in: C) -> Range<C.Index> func copyBytes(to: UnsafeMutableRawBufferPointer) -> Int func difference<C>(from: C) -> CollectionDifference<Self.Element> Returns the difference needed to produce this collection’s ordered elements from the given collection.
func difference<C>(from: C, by: (C.Element, Self.Element) -> Bool) -> CollectionDifference<Self.Element> Returns the difference needed to produce this collection’s ordered elements from the given collection, using the given predicate as an equivalence test.
func drop(while: (Self.Element) throws -> Bool) rethrows -> Self.SubSequence Returns a subsequence by skipping elements while
predicatereturnstrueand returning the remaining elements.func dropFirst(Int) -> Self.SubSequence Returns a subsequence containing all but the given number of initial elements.
func dropLast(Int) -> Self.SubSequence Returns a subsequence containing all but the specified 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: (Self.Element, OtherSequence.Element) throws -> Bool) rethrows -> 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<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((Self.Element) throws -> Bool) rethrows -> [Self.Element] Returns an array containing, in order, the elements of the sequence that satisfy the given predicate.
func first(where: (Self.Element) throws -> Bool) rethrows -> Self.Element? Returns the first element of the sequence that satisfies the given predicate.
func firstIndex(of: Self.Element) -> Self.Index? Returns the first index where the specified value appears in the collection.
func firstIndex(where: (Self.Element) throws -> Bool) rethrows -> Self.Index? Returns the first index in which an element of the collection satisfies the given predicate.
func firstRange<C>(of: C) -> Range<Self.Index>? Finds and returns the range of the first occurrence of a given collection within this collection.
func firstRange<C>(of: C) -> Range<Self.Index>? Finds and returns the range of the first occurrence of a given collection within this collection.
func firstRange<D>(of: D) -> Range<Self.Index>? func flatMap<SegmentOfResult>((Self.Element) throws -> SegmentOfResult) rethrows -> [SegmentOfResult.Element] Returns an array containing the concatenated results of calling the given transformation with each element of this sequence.
func flatmapOffsets(Offsets?) -> Range<Self.Index> func forEach((Self.Element) throws -> Void) rethrows Calls the given closure on each element in the sequence in the same order as a
for-inloop.func formIndex(inout Self.Index, offsetBy: Int) Offsets the given index by the specified distance.
func formIndex(inout Self.Index, offsetBy: Int, limitedBy: Self.Index) -> Bool Offsets the given index by the specified distance, or so that it equals the given limiting index.
func index(atOffset: Int) -> Self.Index func last(where: (Self.Element) throws -> Bool) rethrows -> Self.Element? Returns the last element of the sequence that satisfies the given predicate.
func lastIndex(of: Self.Element) -> Self.Index? Returns the last index where the specified value appears in the collection.
func lastIndex(where: (Self.Element) throws -> Bool) rethrows -> Self.Index? Returns the index of the last element in the collection that matches the given predicate.
func lastRange<D>(of: D) -> Range<Self.Index>? 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: (Self.Element, Self.Element) throws -> Bool) rethrows -> 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 map<T>((Self.Element) throws -> T) rethrows -> [T] Returns an array containing the results of mapping the given closure over the sequence’s elements.
func map<T>((Self.Element) throws -> T) rethrows -> [T] Returns an array containing the results of mapping the given closure over the sequence’s elements.
func mapOffsets(Offsets) -> Range<Self.Index> func max() -> Self.Element? Returns the maximum element in the sequence.
func max(by: (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.
func min() -> Self.Element? Returns the minimum element in the sequence.
func min(by: (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 none((Self.Element) -> Bool) -> Bool func offset(of: Self.Index) -> Int func offset(ofIndex: Self.Index) -> Int func offsets(of: Range<Self.Index>) -> Range<Int> func prefix(Int) -> Self.SubSequence Returns a subsequence, up to the specified maximum length, containing the initial elements of the collection.
func prefix(through: Self.Index) -> Self.SubSequence Returns a subsequence from the start of the collection through the specified position.
func prefix(upTo: Self.Index) -> Self.SubSequence Returns a subsequence from the start of the collection up to, but not including, the specified position.
func prefix(while: (Self.Element) throws -> Bool) rethrows -> Self.SubSequence Returns a subsequence containing the initial elements until
predicatereturnsfalseand skipping the remaining elements.func randomElement() -> Self.Element? Returns a random element of the collection.
func randomElement<T>(using: inout T) -> Self.Element? Returns a random element of the collection, using the given generator as a source for randomness.
func ranges<C>(of: C) -> [Range<Self.Index>] Finds and returns the ranges of the all occurrences of a given sequence within the collection.
func reduce<Result>(Result, (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: Result, (inout Result, Self.Element) throws -> ()) rethrows -> Result Returns the result of combining the elements of the sequence using the given closure.
func reversed() -> ReversedCollection<Self> Returns a view presenting the elements of the collection in reverse order.
func shuffled() -> [Self.Element] Returns the elements of the sequence, shuffled.
func shuffled<T>(using: inout T) -> [Self.Element] Returns the elements of the sequence, shuffled using the given generator as a source for randomness.
func sorted() -> [Self.Element] Returns the elements of the sequence, sorted.
func sorted(by: (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 split(around: Range<Self.Index>) -> (prefix: Self.SubSequence, Self.SubSequence, suffix: Self.SubSequence) func split(maxSplits: Int, omittingEmptySubsequences: Bool, whereSeparator: (Self.Element) throws -> Bool) rethrows -> [Self.SubSequence] Returns the longest possible subsequences of the collection, in order, that don’t contain elements satisfying the given predicate.
func split(separator: Self.Element, maxSplits: Int, omittingEmptySubsequences: Bool) -> [Self.SubSequence] Returns the longest possible subsequences of the collection, 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: (Self.Element, PossiblePrefix.Element) throws -> Bool) rethrows -> 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) -> Self.SubSequence Returns a subsequence, up to the given maximum length, containing the final elements of the collection.
func suffix(from: Self.Index) -> Self.SubSequence Returns a subsequence from the specified position to the end of the collection.
func trimmingPrefix<Prefix>(Prefix) -> Self.SubSequence Returns a new collection of the same type by removing initial elements that satisfy the given predicate from the start.
func trimmingPrefix(while: (Self.Element) throws -> Bool) rethrows -> Self.SubSequence func tryDropPrefix<C>(C) -> Self.SubSequence? Attempts to drop a given prefix from the collection.
func tryDropSuffix<C>(C) -> Self.SubSequence? Attempts to drop a given suffix from the collection.
func flatMap<ElementOfResult>((Self.Element) throws -> ElementOfResult?) rethrows -> [ElementOfResult] func index(of: Self.Element) -> Self.Index? Returns the first index where the specified value appears in the collection.