StructureFoundation5.9.0

Data

@frozen struct Data

Citizens in Foundation

Conformances

protocol BidirectionalCollection
A collection that supports backward as well as forward traversal.
protocol Collection
A sequence whose elements can be traversed multiple times, nondestructively, and accessed by an indexed subscript.
protocol ContiguousBytes
Indicates that the conforming type is a contiguous collection of raw bytes whose underlying storage is directly accessible by withUnsafeBytes.
protocol CustomDebugStringConvertible
A type with a customized textual representation suitable for debugging purposes.
protocol CustomReflectable
A type that explicitly supplies its own mirror.
protocol CustomStringConvertible
A type with a customized textual representation.
protocol DataProtocol
protocol Decodable
A type that can decode itself from an external representation.
protocol Encodable
A type that can encode itself to an external representation.
protocol Equatable
A type that can be compared for value equality.
protocol Hashable
A type that can be hashed into a Hasher to produce an integer hash value.
protocol MutableCollection
A collection that supports subscript assignment.
protocol MutableDataProtocol
protocol RandomAccessCollection
A collection that supports efficient random-access index traversal.
protocol RangeReplaceableCollection
A collection that supports replacement of an arbitrary subrange of elements with the elements of another collection.
protocol ReferenceConvertible
Decorates types which are backed by a Foundation reference type.
protocol Sendable
A type whose values can safely be passed across concurrency domains by copying.
protocol Sequence
A type that provides sequential, iterated access to its elements.

Members

init()
Initialize an empty Data.
init<S>(S)
init?(base64Encoded: Data, options: Data.Base64DecodingOptions)
Initialize a Data from a Base-64, UTF-8 encoded Data.
init?(base64Encoded: String, options: Data.Base64DecodingOptions)
Initialize a Data from a Base-64 encoded String using the given options.
init<SourceType>(buffer: UnsafeBufferPointer<SourceType>)
Initialize a Data with copied memory content.
init<SourceType>(buffer: UnsafeMutableBufferPointer<SourceType>)
Initialize a Data with copied memory content.
init(bytes: UnsafeRawPointer, count: Int)
Initialize a Data with copied memory content.
init(bytesNoCopy: UnsafeMutableRawPointer, count: Int, deallocator: Data.Deallocator)
Initialize a Data without copying the bytes.
init(capacity: Int)
Initialize a Data with the specified size.
init(contentsOf: URL, options: Data.ReadingOptions) throws
Initialize a Data with the contents of a URL.
init(count: Int)
Initialize a Data with the specified count of zeroed bytes.
init(from: Decoder) throws
init(referencing: NSData)
Initialize a Data by adopting a reference type.
init(repeating: UInt8, count: Int)
Initialize a Data with a repeating byte pattern
var count: Int
The number of bytes in the data.
var customMirror: Mirror
var debugDescription: String
A human-readable debug description for the data.
var description: String
A human-readable description for the data.
var endIndex: Data.Index
The end Index into the data.
var indices: Range<Int>
var regions: CollectionOfOne<Data>
var startIndex: Data.Index
The start Index in the data.
subscript(Range<Data.Index>) -> Data
subscript<R>(R) -> Data
subscript(Data.Index) -> UInt8
Sets or returns the byte at the specified index.
static func == (Data, Data) -> Bool
Returns true if the two Data arguments are equal.
func advanced(by: Int) -> Data
func append(Data)
func append<SourceType>(UnsafeBufferPointer<SourceType>)
Append a buffer of bytes to the data.
func append(UnsafePointer<UInt8>, count: Int)
func append(contentsOf: [UInt8])
func append<S>(contentsOf: S)
func base64EncodedData(options: Data.Base64EncodingOptions) -> Data
Returns a Base-64 encoded Data.
func base64EncodedString(options: Data.Base64EncodingOptions) -> String
Returns a Base-64 encoded string.
func copyBytes(to: UnsafeMutablePointer<UInt8>, count: Int)
Copy the contents of the data to a pointer.
func copyBytes<DestinationType>(to: UnsafeMutableBufferPointer<DestinationType>, from: Range<Data.Index>?) -> Int
This function copies the bytes in range from the data into the buffer. If the count of the range is greater than MemoryLayout<DestinationType>.stride * buffer.count then the first N bytes will be copied into the buffer.
func copyBytes(to: UnsafeMutablePointer<UInt8>, from: Range<Data.Index>)
Copy a subset of the contents of the data to a pointer.
func encode(to: Encoder) throws
func hash(into: inout Hasher)
The hash value for the data.
func index(after: Data.Index) -> Data.Index
func index(before: Data.Index) -> Data.Index
func makeIterator() -> Data.Iterator
An iterator over the contents of the data.
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 replaceSubrange(Range<Data.Index>, with: Data)
Replace a region of bytes in the data with new data.
func replaceSubrange<SourceType>(Range<Data.Index>, with: UnsafeBufferPointer<SourceType>)
Replace a region of bytes in the data with new bytes from a buffer.
func replaceSubrange<ByteCollection>(Range<Data.Index>, with: ByteCollection)
Replace a region of bytes in the data with new bytes from a collection.
func replaceSubrange(Range<Data.Index>, with: UnsafeRawPointer, count: Int)
func reserveCapacity(Int)
func resetBytes(in: Range<Data.Index>)
Set a region of the data to 0.
func subdata(in: Range<Data.Index>) -> Data
Return a new copy of the data in a specified range.
func withUnsafeBytes<ResultType>((UnsafeRawBufferPointer) throws -> ResultType) rethrows -> ResultType
func withUnsafeMutableBytes<ResultType>((UnsafeMutableRawBufferPointer) throws -> ResultType) rethrows -> ResultType
func write(to: URL, options: Data.WritingOptions) throws
Write the contents of the Data to a location.
enum Deallocator
When creating a Data with the no-copy initializer, you may specify a Data.Deallocator to customize the behavior of how the backing store is deallocated.
struct Iterator
typealias Base64DecodingOptions
typealias Base64EncodingOptions
typealias Index
typealias Indices
typealias ReadingOptions
typealias ReferenceType
typealias SearchOptions
typealias WritingOptions
init(bytes: Array<UInt8>)
init(bytes: ArraySlice<UInt8>)
init<S>(bytes: S)
func enumerateBytes((UnsafeBufferPointer<UInt8>, Data.Index, inout Bool) -> Void)
Enumerate the contents of the data.
func withUnsafeBytes<ResultType, ContentType>((UnsafePointer<ContentType>) throws -> ResultType) rethrows -> ResultType
Access the bytes in the data.
func withUnsafeMutableBytes<ResultType, ContentType>((UnsafeMutablePointer<ContentType>) throws -> ResultType) rethrows -> ResultType
Mutate the bytes in the data.

Features

var first: Self.Element?
The first element of the collection.
var halfWidthCornerQuoted: String
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 map and filter, are implemented lazily.
static func != (Self, Self) -> Bool
static func + <Other>(Other, Self) -> Self
Creates a new collection by concatenating the elements of a sequence and a collection.
static func + <Other>(Self, Other) -> Self
Creates a new collection by concatenating the elements of a collection and a sequence.
static func + <Other>(Self, Other) -> Self
Creates a new collection by concatenating the elements of two collections.
static func += <Other>(inout Self, Other)
Appends the elements of a sequence to a range-replaceable collection.
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 applying(CollectionDifference<Self.Element>) -> Self?
Applies the given difference to this collection.
func compactMap<ElementOfResult>((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 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 predicate returns true and 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
Returns a new collection of the same type containing, in order, the elements of the original collection 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-in loop.
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 popFirst() -> Self.Element?
Removes and returns the first element of the collection.
func popLast() -> Self.Element?
Removes and returns the last element of the collection.
func popLast() -> Self.Element?
Removes and returns the last element of the collection.
func popLast() -> Self.Element?
Removes and returns the last element of the collection.
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 predicate returns false and 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 removeFirst() -> Self.Element
Removes and returns the first element of the collection.
func removeFirst(Int)
Removes the specified number of elements from the beginning of the collection.
func removeLast() -> Self.Element
Removes and returns the last element of the collection.
func removeLast() -> Self.Element
Removes and returns the last element of the collection.
func removeLast() -> Self.Element
Removes and returns the last element of the collection.
func removeLast(Int)
Removes the given number of elements from the end of the collection.
func removeLast(Int)
Removes the specified number of elements from the end of the collection.
func removeLast(Int)
Removes the specified number of elements from the end of the collection.
func replace<C, Replacement>(C, with: Replacement, maxReplacements: Int)
Replaces all occurrences of a target sequence with a given collection
func replacing<C, Replacement>(C, with: Replacement, maxReplacements: Int) -> Self
Returns a new collection in which all occurrences of a target sequence are replaced by another collection.
func replacing<C, Replacement>(C, with: Replacement, subrange: Range<Self.Index>, maxReplacements: Int) -> Self
Returns a new collection in which all occurrences of a target sequence are replaced by another collection.
func reverse()
Reverses the elements of the collection in place.
func reversed() -> ReversedCollection<Self>
Returns a view presenting the elements of the collection in reverse order.
func shuffle()
Shuffles the collection in place.
func shuffle<T>(using: inout T)
Shuffles the collection in place, using the given generator as a source for randomness.
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 sort()
Sorts the collection in place.
func sort(by: (Self.Element, Self.Element) throws -> Bool) rethrows
Sorts the collection in place, using the given predicate as the comparison between elements.
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 trimPrefix<Prefix>(Prefix)
Removes the initial elements that satisfy the given predicate from the start of the sequence.
func trimPrefix<Prefix>(Prefix)
Removes the initial elements that satisfy the given predicate from the start of the sequence.
func trimPrefix(while: (Self.Element) throws -> Bool) throws
func trimPrefix(while: (Self.Element) throws -> Bool) rethrows
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.

Extension in BSON

Conformances

Features

func equals(Primitive) -> Bool

Extension in MultipartKit

Conformances

protocol MultipartPartConvertible

Members

Extension in NIOFoundationCompat

Members

init(buffer: ByteBuffer, byteTransferStrategy: ByteBuffer.ByteTransferStrategy)
Creates a Data from a given ByteBuffer. The entire readable portion of the buffer will be read.

Extension in Vapor

Members

init?(base32Encoded: Data)
Decodes relaxed-Base32-encoded Data. Returns nil if the input is not valid relaxed-Base32.
init?(base32Encoded: String)
Decodes a relaxed-Base32-encoded String. Returns nil if the input is not valid relaxed-Base32.
func base32EncodedData() -> Data
Return this Data encoded with relaxed-Base32 as Data.
func base32EncodedString() -> String
Return this Data encoded with relaxed-Base32 as a String.