Structure

Data

iOS 8.0+ iPadOS 8.0+ Mac Catalyst 8.0+ macOS 10.10+ tvOS 9.0+ watchOS 2.0+

A byte buffer in memory.

@frozen struct Data

Overview

The Data value type allows simple byte buffers to take on the behavior of Foundation objects. You can create empty or pre-populated buffers from a variety of sources and later add or remove bytes. You can filter and sort the content, or compare against other buffers. You can manipulate subranges of bytes and iterate over some or all of them.

Data bridges to the NSData class and its mutable subclass, NSMutableData. You can use these interchangeably in code that interacts with Objective-C APIs.

Topics

Structures

struct Base64DecodingOptions
struct Base64EncodingOptions
struct ReadingOptions
Options to control the reading of data from a URL.
struct SearchOptions
Options that control a data search operation.
struct WritingOptions
Options to control the writing of data to a URL.

Initializers

init()
Creates an empty data buffer.
init(_:)
init(base64Encoded:options:)
Initialize a Data from a Base-64, UTF-8 encoded Data.
init(buffer:)
Creates a data buffer with copied memory content using a buffer pointer.
init(bytes:)
init(bytes: UnsafeRawPointer, count: Int)
Creates data with copied memory content.
init(bytesNoCopy: UnsafeMutableRawPointer, count: Int, deallocator: Data.Deallocator)
Creates a data buffer with memory content without copying the bytes.
init(capacity: Int)
Creates an empty data buffer of a specified size.
init(contentsOf: URL, options: Data.ReadingOptions) throws
Creates data by reading from the specified URL.
init(count: Int)
Creates a new data buffer with the specified count of zeroed bytes.
init(repeating: UInt8, count: Int)
Initialize a Data with a repeating byte pattern

Instance Properties

var bytes: RawSpan
var count: Int
The number of bytes in the data.
var endIndex: Data.Index
The end Index into the data.
var indices: Range<Int>
var mutableBytes: MutableRawSpan
var mutableSpan: MutableSpan<UInt8>
var span: Span<UInt8>
var startIndex: Data.Index
The beginning index into the data.

Instance Methods

func advanced(by: Int) -> Data
Returns a new data buffer created by removing the given number of bytes from the front of the original data.
func append(_:)
func append(UnsafePointer<UInt8>, count: Int)
Appends the specified bytes from memory to the end of the data.
func append(contentsOf:)
Appends the bytes in the specified sequence to the end of the data.
func base64EncodedData(options: Data.Base64EncodingOptions) -> Data
Returns Base-64 encoded data.
func base64EncodedString(options: Data.Base64EncodingOptions) -> String
Returns a Base-64 encoded string.
func copyBytes(to: UnsafeMutablePointer<UInt8>, count: Int)
Copies the contents of the data to memory.
func copyBytes(to:from:)
Copies a subset of the contents of the data to memory.
func enumerateBytes((UnsafeBufferPointer<UInt8>, Data.Index, inout Bool) -> Void)
Enumerates the contents of the data’s buffer.
func index(after: Data.Index) -> Data.Index
Returns the index that immediately follows the specified index.
func index(before: Data.Index) -> Data.Index
Returns the index that immediately precedes the specified index.
func insert(UInt8, at: Data.Index)
func range(of: Data, options: Data.SearchOptions, in: Range<Data.Index>?) -> Range<Data.Index>?
Find the given Data in the content of this Data.
func remove(at: Data.Index) -> UInt8
func removeAll(keepingCapacity: Bool)
func removeSubrange(Range<Data.Index>)
func repalceSubrangeFast(_:with:)
Replaces a region of bytes in the data with new bytes from a collection.
func replaceSubrange(Range<Data.Index>, with: UnsafeRawPointer, count: Int)
Replaces a region of bytes in the data with bytes from memory.
func reserveCapacity(Int)
Prepares the collection to store the specified number of elements, when doing so is appropriate for the underlying type.
func resetBytes(in: Range<Data.Index>)
Sets a region of the data buffer to 0.
func subdata(in: Range<Data.Index>) -> Data
Returns a new copy of the data in a specified range.
func withContiguousStorageIfAvailable<E, ResultType>((UnsafeBufferPointer<UInt8>) throws(E) -> ResultType) throws(E) -> ResultType?
func withUnsafeBytes(_:)
func withUnsafeMutableBytes(_:)
func write(to: URL, options: Data.WritingOptions) throws
Writes the contents of the data buffer to a location.

Subscripts

subscript(_:)
Accesses the bytes at the specified range of indexes.

Type Aliases

typealias Index
A type used to indicate a position in a data’s buffer.
typealias Indices
A type used to indicate a range of positions in a data’s buffer.

Enumerations

enum Deallocator
A deallocator you use to customize how the backing store is deallocated for data created with the no-copy initializer.

Default Implementations

Relationships

Conforms To

ContiguousBytes
DataProtocol
MultipartKit.MultipartPartConvertible
MutableDataProtocol
Swift.BidirectionalCollection
Swift.Collection
Swift.Copyable
Swift.CustomDebugStringConvertible
Swift.CustomReflectable
Swift.CustomStringConvertible
Swift.Decodable
Swift.Encodable
Swift.Equatable
Swift.Escapable
Swift.Hashable
Swift.MutableCollection
Swift.RandomAccessCollection
Swift.RangeReplaceableCollection
Swift.Sendable
Swift.SendableMetatype
Swift.Sequence