Class

NSData

A static byte buffer that bridges to Data; use NSData when you need reference semantics or other Foundation-specific behavior.

Overview

NSData and its mutable subclass NSMutableData provide data objects, object-oriented wrappers for byte buffers. Data objects let simple allocated buffers (that is, data with no embedded pointers) take on the behavior of Foundation objects.

NSData creates static data objects, and NSMutableData creates dynamic data objects. NSData and NSMutableData are typically used for data storage and are also useful in Distributed Objects applications, where data contained in data objects can be copied or moved between applications.

The size of the data is subject to a theoretical limit of about 8 ExaBytes (in practice, the limit should not be a factor).

NSData is “toll-free bridged” with its Core Foundation counterpart, CFData. See Toll-Free Bridging for more information on toll-free bridging.

Saving Data

The NSData class and its subclasses provide methods to quickly and easily save their contents to disk. To minimize the risk of data loss, these methods provide the option of saving the data atomically. Atomic writes guarantee that the data is either saved in its entirety, or it fails completely. The atomic write begins by writing the data to a temporary file. If this write succeeds, then the method moves the temporary file to its final location.

While atomic write operations minimize the risk of data loss due to corrupt or partially-written files, they may not be appropriate when writing to a temporary directory, the user’s home directory or other publicly accessible directories. Any time you work with a publicly accessible file, you should treat that file as an untrusted and potentially dangerous resource. An attacker may compromise or corrupt these files. The attacker can also replace the files with hard or symbolic links, causing your write operations to overwrite or corrupt other system resources.

Avoid using the write(to:atomically:) method (and the related methods) when working inside a publicly accessible directory. Instead initialize an FileHandle object with an existing file descriptor and use the NSFileHandle methods to securely write the file.

For more information, see Securing File Operations in Secure Coding Guide.

Topics

Creating Data

init(bytes: UnsafeRawPointer?, length: Int)

Returns a data object filled with a given number of bytes copied from a given buffer.

init(bytesNoCopy: UnsafeMutableRawPointer, length: Int)

Returns 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)? = nil)

Returns a data object filled with a given number of bytes of data from a given buffer, with a custom deallocator block.

init(bytesNoCopy: UnsafeMutableRawPointer, length: Int, freeWhenDone: Bool)

Initializes a newly allocated data object by adding the given number of bytes from the given buffer.

init(data: Data)

Returns a data object initialized with the contents of another data object.

Reading Data from File

init?(contentsOfFile: String)

Returns a data object initialized with the content of the file at a given path.

init(contentsOfFile: String, options: NSData.ReadingOptions = [])

Returns a data object initialized with the content of the file at a given path.

init?(contentsOf: URL)

Initializes a newly allocated data object with the data from the location specified by a given URL.

init(contentsOf: URL, options: NSData.ReadingOptions = [])

Returns a data object initialized with the data from the location specified by a given URL.

struct NSData.ReadingOptions

Options for methods used to read data objects.

class func dataWithContentsOfMappedFile(String)

Creates and returns a data object from the mapped file at a given path.

Deprecated
init?(contentsOfMappedFile: String)

Returns a data object initialized by reading into it the mapped file specified by a given path.

Deprecated

Writing Data to File

func write(toFile: String, atomically: Bool)

Writes the data object's bytes to the file specified by a given path.

func write(toFile: String, options: NSData.WritingOptions = [])

Writes the data object's bytes to the file specified by a given path.

func write(to: URL, atomically: Bool)

Writes the data object's bytes to the location specified by a given URL.

func write(to: URL, options: NSData.WritingOptions = [])

Writes the data object's bytes to the location specified by a given URL.

struct NSData.WritingOptions

Options for methods used to write data objects.

Base-64 Encoding

init?(base64Encoded: Data, options: NSData.Base64DecodingOptions = [])

Returns a data object initialized with the given Base-64 encoded data.

init?(base64Encoded: String, options: NSData.Base64DecodingOptions = [])

Returns a data object initialized with the given Base-64 encoded string.

func base64EncodedData(options: NSData.Base64EncodingOptions = [])

Create a Base-64, UTF-8 encoded data object from the receiver's contents using the given options.

func base64EncodedString(options: NSData.Base64EncodingOptions = [])

Create a Base-64 encoded string from the receiver's contents using the given options.

struct NSData.Base64EncodingOptions

Options for methods used to Base-64 encode data.

struct NSData.Base64DecodingOptions

Options to modify the decoding algorithm used to decode Base-64 encoded data objects.

init?(base64Encoding: String)

Returns a data object initialized with the given Base-64 encoded string.

Deprecated
func base64Encoding()

Create a Base-64 encoded string from the receiver's contents.

Deprecated

Accessing Underlying Bytes

var bytes: UnsafeRawPointer

A pointer to the receiver’s contents.

func enumerateBytes((UnsafeRawPointer, NSRange, UnsafeMutablePointer<ObjCBool>) -> Void)

Enumerates each range of bytes in the data object using a block.

func getBytes(UnsafeMutableRawPointer)

Copies a data object’s contents into a given buffer.

Deprecated
func getBytes(UnsafeMutableRawPointer, length: Int)

Copies a number of bytes from the start of the receiver's data into a given buffer.

func getBytes(UnsafeMutableRawPointer, range: NSRange)

Copies a range of bytes from the receiver’s data into a given buffer.

Finding Data

func subdata(with: NSRange)

Returns a data object containing the receiver’s bytes that fall within the limits specified by a given range.

func range(of: Data, options: NSData.SearchOptions = [], in: NSRange)

Finds and returns the range of the first occurrence of the given data, within the given range, subject to given options.

struct NSData.SearchOptions

Options for method used to search data objects.

Testing Data

func isEqual(to: Data)

Returns a Boolean indicating whether this data object is the same as another.

var length: Int

The number of bytes contained by the data object.

func contains(UInt8)

Returns a Boolean value indicating whether the sequence contains the given element.

func contains(where: (UInt8) -> Bool)

Returns a Boolean value indicating whether the sequence contains an element that satisfies the given predicate.

Describing Data

var description: String

A string that contains a hexadecimal representation of the object’s contents in a property list format.

See Also

Using Reference Types

class NSMutableData

A dynamic byte buffer that bridges to Data; use NSMutableData when you need reference semantics or other Foundation-specific behavior.

typealias Data.ReferenceType

An alias for this value type's equivalent reference type.